API de Nota Fiscal v.2

Melhorias:

• Nota Fiscal de Remessa gerada pelo auto serviço;
• XML de Evento de Cancelamento de Nota Fiscal;
• Consultar Status das Notas Fiscais;
• Mais parâmetros de busca.

O intuito desta API é dar a possiblidade ao lojista, de forma integrada, conseguir consultar e baixar o XML da Nota Fiscal de venda gerado para um determinado pedido. Abaixo mostraremos o passo a passo de como deve ser desenvolvida:

Referência: Documentação Swagger

https://hk-v2.api-myrockit.com.br/doc/index.php

Passo a Passo integração com API Rock.IT Este guia orienta como utilizar os principais endpoints da API Rock.IT para testes de integração.

Dados de teste (Obrigatória para todos os testes):

• Email: teste@teste.com.br
• Senha: 7&oyH44tF
• IDCompany: 3
• Pedidos de exemplo:
• Pedido normal: 2855085
• Pedido cancelado: 2855135

1. AUTENTICAÇÃO DE USUÁRIO

Descrição: Este serviço é responsável por gerar a API KEY que será utilizada nos demais endpoits da API para baixar o XML da NF. Ela fica ativa por 4 horas, sendo necessário gerar uma nova após expiração por conta do prazo.

Faça uma requisição: POST https://hk-v2.api-myrockit.com.br/login

Header:

• Content-Type:application/json
• Accept:application/json

Body request:

{
  "email": "teste@teste.com.br",
  "password": "7&oyH44tF"
}

Body response:

json

curl --location 'https://hk-v2.api-myrockit.com.br/login' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: {{apiKey}}' \
--data-raw '{
"email": "teste@teste.com.br",
"password": "admin"
}'

2. CONSULTAR PEDIDOS

Retorna todos os pedidos da empresa especificada. IDCompany é obrigatório e pode ser fornecido no cabeçalho. A API verificará se o usuário tem acesso à empresa especificada com base em seu token JWT.

Importante: As notas fiscais de remessa para armazenagem estão disponíveis nessa API, sendo possível identificar pelo "TypeOrder": "Remessa".

Realize requisição: GET https://hk-v2.api-myrockit.com.br/orders

Inclua no Header:

• Authorization: Bearer (Token)
• IDCompany: 3
• Pedido de exemplo para testar: IDOrder 2855085

curl --location 'https://hk-v2.api-myrockit.com.br/orders?IDOrder=2855085'
--header 'IDCompany: 3' obs: informar o jwt

3. DOWNLOAD XML DA NOTA FISCAL

Descrição: Este endpoint é responsável por baixar a NF de venda gerada pelo ERP Rock.IT para que a loja possa obtê-la de forma integrada.

Envie uma requisição: POST https://hk-v2.api-myrockit.com.br/orders/xml/download

Exemplo Body Request

curl 
--location 'https://hk-v2.api-myrockit.com.br/orders/xml/download' \
--header 'IDCompany: 3' \
--header 'Content-Type: application/json' \
--data '{
"IDOrder": [
2855085
]
}'

4. UPLOAD XML DA NOTA FISCAL

Descrição: Carregue um arquivo XML para um pedido.

Envie uma requisição: POST https://hk-v2.api-myrockit.com.br/orders/xml/upload

Inclua no Header:

• Authorization: Bearer (Token)
• IDCompany: 3

Body:

• XML da nota
• IDOrder, Order ou OrderFrom

curl --location 'https://hk-v2.api-myrockit.com.br/orders/xml/upload?IDOrder=123456789'
--header 'IDCompany: 3'
--header 'Content-Type: application/xml'
--data 'xml'

5. CONSULTAR STATUS DE PEDIDOS

Descrição: Para facilitar a consulta dos pedidos massivamente, conforme o status do pedido, criamos (17/03/2025) esse endpoint, que apresenta todos códigos dos status que um pedido pode ter.

Por exemplo: É possível filtrar pedidos no status Nota fiscal por determinado período.

Envie uma requisição: GET https://hk-v2.api-myrockit.com.br/orders/status

• Serve para listar os possíveis status de pedidos.

curl --location 'https://hk-v2.api-myrockit.com.br/orders/status'

6. CONSULTAR STATUS DAS NOTAS FISCAIS

Descrição: Para facilitar a consulta dos pedidos massivamente, conforme o status do pedido, criamos (29/06/2025) esse endpoint, que apresenta todos códigos dos status que uma nota fiscal pode ter.

Por exemplo: É possível filtrar pedidos no status Cancelada por determinado período.

Envie uma requisição: GET https://hk-v2.api-myrockit.com.br/orders/invoice/status

• Retorna os status das NFs (ex: canceladas, emitidas).

curl --location 'https://hk-v2.api-myrockit.com.br/orders/invoice/status'

7. BAIXAR XML DO EVENTO DE CANCELAMENTO

Descrição: Este endpoint é responsável por baixar o XML do evento de cancelamento gerada pelo ERP Rock.IT para que a loja possa obtê-la de forma integrada.

Envie uma requisição: POST https://hk-v2.api-myrockit.com.br/orders/xml/canceled/download

curl --location 'https://hk-v2.api-myrockit.com.br/orders/xml/canceled/download'
--header 'IDCompany: 3'
--header 'Content-Type: application/json'
--data

Body de exemplo:

{
"IDOrder": [2855135]
}

'{ "IDOrder": [
2855135 ] }'  

Observação: Todos os dados são exclusivamente para testes. API de Nota Fiscal v2: 01/07/2025