Criação de conta
Para ter acesso aos recursos disponibilizados pela API, é necessário possuir uma conta de desenvolvedor.
Clique aqui e inscreva-se.
Criação de App
Para ter acesso ao ambiente de homologação (HLG), você precisa criar uma App. A criação somente poderá ser realizada após logar-se, seguindo o caminho:
- Acesse o menu superior com o seu nome de usuário
- Clique em Meus apps
- Clique em Criar novo app
- Clique em Selecione Marketplace
- Clique em Preencha os dados solicitados
- Clique em Selecione as APIs que deseja ter acesso
Fique atento!
A App + token são criados em um único código, mas que é separado em duas partes, como no exemplo abaixo:_
123456789:987654321
Antes do separador “:” = App
Depois do separador “:” = Token
Este entendimento é importante, pois o header de qualquer chamada (HLG ou PRD) é composto sempre por ambos os códigos.
Serviços obrigatórios para homologação
Para que possamos homologá-lo com sucesso, é necessário que faça, no mínimo, o desenvolvimento de todos os serviços abaixo da maneira correta:
Mapeamento de categoria
Controle e gestão de oferta
Exclusão de produto
Controle e gestão de pedidos (logística própria)
Controle e gestão de pedidos (Envvias)
| Desenvolver | Método | Endpoint |
|---|---|---|
| Consulta de pedido (unitária e/ou massiva) | GET | /api/v2/orders/{orderId} |
| Enviar NF de pedido | POST | /api/v2/orders/{orderId}/trackings/invoice} |
| Solicitar etiqueta | POST | /api/v2/orders/{orderId}/generate-label} |
| Consulta de etiqueta gerada | GET | /api/v2/orders/{orderId}/labels |
Controle e gestão de protocolos (atendimento)
| Desenvolver | Método | Endpoint |
|---|---|---|
| Consulta de incidentes e fila | GET | /incidents |
| Criar incidente | POST | /incidents |
| Consulta de soluções | GET} | /solutions |
| Interação com cliente | PATCH} | /solutions |
| Extração de relatórios | POST | /reports |
| Inclusão de anexo em incidente | POST} | /attachments |
