Visão Geral da API

A Carrot API é uma API centrada em documentos utilizada por Integradores para enviar e recuperar dados de rastreabilidade. A superfície pública é intencionalmente pequena: 6 endpoints em 3 recursos (documents, events, attachments).

URL base

• API: https://api.carrot.eco
• Auth: https://auth.api.carrot.eco/oauth2/token
• Explorer: https://explore.carrot.eco

Convenções principais

• O tipo de conteúdo é JSON para requisições e respostas da API.
• Valores de data e hora seguem ISO 8601 (por exemplo, 2020-01-01T00:00:00.000Z).
• Campos de metadados são estruturas flexíveis de chave-valor.
• O histórico de documentos é apenas por adição (append-only) através de eventos.

Ambientes

A Carrot utiliza a mesma URL base para tráfego de teste e produção. A seleção do ambiente é baseada no clientId utilizado para solicitar um token de acesso.

• Credenciais de teste só podem operar em documentos de teste.
• Credenciais de produção só podem operar em documentos de produção.
• Relações entre documentos de ambientes diferentes não são permitidas.

Mapa de recursos

• Autenticação: fluxo de credenciais de cliente OAuth 2.0 e ciclo de vida do token.
• Documentos: criar e recuperar documentos.
• Eventos: adicionar eventos imutáveis às linhas do tempo dos documentos, individualmente ou em lote.
• Anexos: gerar URLs presigned para upload/download.
• Erros: códigos de erro, limites de taxa e solução de problemas.

Início rápido da integração

Para uma sequência completa de onboarding, consulte Início Rápido de Integrações.