Pular para o conteúdo
Cotejar para desenvolvedores
Pesquisar
Ctrl
K
Cancelar
Selecionar tema
Escuro
Claro
Auto
Comece aqui
Visão geral
Primeira requisição
Autenticação e permissões
Recursos
Conta e empresa
Estabelecimentos
Catálogos
Produtos e identidade externa
Fluxos
Ingestão em lote
Análises e resultados
Vigilância
Webhooks
Fundamentos
Erros e repetição segura
Paginação e limites
Segurança
Referência da API
Visão geral
Conta e empresa
Visão geral
Consultar o contexto da integração
GET
Consultar capacidade compartilhada e disponibilidade de análise
GET
Consultar a identidade da empresa autorizada
GET
Catálogos
Visão geral
Iniciar ingestão no catálogo selecionado
POST
Enviar lote canônico
PUT
Fechar lotes e validar a prévia
POST
Consultar ingestão e prévia
GET
Agendar aplicação da prévia validada
POST
Consultar produtos de um catálogo ativo
GET
Consultar catálogos da empresa
GET
Criar catálogo para estabelecimento existente
POST
Consultar identidade, estado e versão de um catálogo
GET
Excluir catálogo após conferir impacto
DELETE
Editar nome ou referência externa do catálogo
PATCH
Consultar o impacto da exclusão do catálogo
GET
Produtos
Visão geral
Cadastrar produto neste catálogo
POST
Consultar um produto por seu identificador Cotejar
GET
Editar parcialmente um produto compartilhado
PATCH
Vincular produto existente a este catálogo
PUT
Retirar produto deste catálogo
DELETE
Consultar produtos da empresa
GET
Estabelecimentos
Visão geral
Consultar matriz e filiais da empresa
GET
Cadastrar matriz ou filial
POST
Consultar identidade e versão de um estabelecimento
GET
Arquivar estabelecimento sem catálogo ativo
DELETE
Editar nome ou referência do estabelecimento
PATCH
Acompanhar solicitação de correção de CNPJ
GET
Solicitar revisão do CNPJ de um estabelecimento
POST
Vigilância
Visão geral
Listar execuções de vigilância da empresa
GET
Consultar execução da vigilância
GET
Exportar o resultado publicado da vigilância em CSV
GET
Consultar achados imutáveis da vigilância
GET
Consultar seleção e capacidade compartilhadas
GET
Trocar produtos selecionados ou vigiar todos
PATCH
Consultar os produtos selecionados
GET
Webhooks
Visão geral
Listar eventos e estado das entregas
GET
Consultar evento e situação da entrega
GET
Consultar tentativas do evento
GET
Agendar evento de teste
POST
Agendar reenvio de evento encerrado
POST
Consultar configuração do webhook
GET
Configurar ou rotacionar webhook
PUT
Revogar webhook
DELETE
Análises
Visão geral
Listar execuções de análise da empresa
GET
Solicitar análise completa da empresa
POST
Consultar execução e resumo da análise
GET
Exportar o resultado completo da análise em CSV
GET
Consultar todos os achados da análise
GET
Especificação
Baixar OpenAPI JSON
Selecionar tema
Escuro
Claro
Auto
Visão geral
Análises
Seção intitulada “Análises”
Aceite durável e resultados completos da análise.
Operações
Seção intitulada “Operações”
GET
/v1/analises
POST
/v1/analises
GET
/v1/analises/{id}
GET
/v1/analises/{id}/resultados.csv
GET
/v1/analises/{id}/resultados