Documentação Comexdoc
Uma plataforma, vários produtos. O que você aprende para integrar com o primeiro vale para os outros: a mesma chave, o mesmo formato de erro, o mesmo webhook, a mesma paginação.
Como isto está organizado
A documentação tem duas partes. A da plataforma vale para tudo: autenticação, entrega por webhook, formato de erro, paginação. Você lê uma vez.
A de cada produto traz só o que é dele: as rotas que oferece e o formato do que devolve.
Os produtos
| Produto | O que faz | Situação |
|---|---|---|
| eBL | Lê um Bill of Lading em PDF ou imagem e devolve JSON estruturado, com cada campo separado | Disponível |
| Tabelas | Consulta às tabelas oficiais do comércio exterior, começando pela NCM da Receita | Disponível |
| DUIMP | Declaração Única de Importação | Em desenvolvimento |
| CE Mercante | Conhecimento Eletrônico do Mercante | Em desenvolvimento |
| Packing List | Romaneio de carga | Em desenvolvimento |
O que vale para todos
| Assunto | Onde |
|---|---|
| Autenticação | Chave de API: como criar, como usar, como trocar sem derrubar a integração |
| Entregas por webhook | Conferir a assinatura, a escala de reentrega, a fila quando falha |
| Erros e limites | O formato de um erro, o que é retentável, o que cobra e o que não cobra |
| Referência da API | Cada rota e cada campo |
A primeira chamada
Toda rota usa a mesma chave, criada no portal em Conta › Chaves de API. A base e a versão também são as mesmas.
curl https://comexdoc.com.br/v1/ebl/documents \ -H "Authorization: Bearer cxd_live_..."
Produtos que processam um arquivo são assíncronos. O POST responde 202 com um identificador de job, e o resultado chega por webhook ou por consulta. É o caso do eBL.
Produtos que só consultam respondem na hora, sem job e sem webhook. É o caso de Tabelas.