Desenvolvedores
Integre outros sistemas da prefeitura pela API.
Começar a usar a API
Do zero à primeira chamada: peça a integração, guarde o token e faça a primeira busca no acervo.
Autenticação
Token Bearer das integrações, login por aparelho dos aplicativos, troca de token, IPs liberados e os erros 401 e 403.
Escopos e recorte
O que cada escopo libera, quais documentos a integração enxerga, campos sensíveis mascarados e documentos sigilosos.
Limites de uso
Quantas chamadas por minuto cada cliente pode fazer, os cabeçalhos X-RateLimit e como tratar o erro 429 com espera e nova tentativa.
Webhooks
Receba um aviso assinado quando um documento for cadastrado, alterado ou autenticado, e confira a assinatura antes de confiar nele.
Referência da API
Todos os endpoints da API v1, com método, caminho, escopo exigido e o que cada um faz.