Documentação da API odjud
A odjud expõe uma API REST JSON versionada em https://odjud-api.orvyadigital.com.br/v1, com especificação OpenAPI 3.1 em https://odjud-api.orvyadigital.com.br/v1/openapi.json e referência interativa.
Conceitos em 1 minuto
| Conceito | Resumo |
|---|---|
| Ambientes | Chaves odj_test_… usam a fonte sandbox (dados sintéticos, créditos sem valor). Chaves odj_live_… usam fontes reais somente quando liberadas comercialmente. |
| Buscas assíncronas | POST devolve 202 Accepted com id; acompanhe por GET /v1/searches/{id} ou pelo webhook search.completed. |
| Créditos | 100 créditos = R$ 1,00. Reserva antes, captura só no resultado útil. |
| Erros | RFC 9457 (application/problem+json) com code e requestId. |
| Fuso e datas | ISO 8601 com offset/UTC; datas sem hora das fontes seguem America/Sao_Paulo. |
Guias
- Início rápido — primeira consulta por número CNJ e polling.
- Autenticação e chaves — escopos, rotação, revogação.
- Consultas por modalidade e OAB
- Webhooks — assinatura, anti-replay e retentativas.
- Créditos, cobrança e faturamento
- Limites, cache e retenção
- Erros
- SDKs e exemplos
- Portal do cliente
Estado atual das fontes: nenhuma fonte real está liberada para uso comercial (aguardando direito de uso/redistribuição). Com chave live, a API responde
403 SOURCE_NOT_COMMERCIALLY_ENABLEDantes de consultar e sem cobrança. Toda a integração pode ser desenvolvida e testada com chaves de teste. Veja Cobertura.