Referência da API

Cada endpoint desta referência é uma solicitação POST para https://api.croma.run, autenticada com uma chave de API do tipo bearer. Escolha um endpoint na barra lateral para ver seu esquema completo, uma solicitação de exemplo e um playground de “experimente”.

​

Países suportados

Os endpoints são agrupados por país, e cada país tem seu próprio prefixo de rota: GET /jobs/{id} não depende do país: retorna o estado de qualquer trabalho assíncrono.

​

Convenções

• Auth: Authorization: Bearer <key> em cada endpoint. Consulte Autenticação.
• Sucesso: as respostas envolvem a carga útil sob data: { "data": … }.
• Erros: { "error": { "type", "code", "message" } } com um status diferente de 2xx. Consulte Erros.
• Sem correspondência: um registro consultado que não existe é um 200, não um 404: as consultas de um único registro retornam found: false e as consultas de lista retornam um array vazio.
• Limites de taxa: são reportados por meio dos cabeçalhos de resposta X-RateLimit-*. Consulte Limites de taxa.
• Trabalhos assíncronos: as consultas de longa duração podem retornar um 202 com um trabalho que você pode acompanhar por polling ou receber via callback. Consulte a lista em Trabalhos assíncronos.