Documentação da API SNRJ
Introdução
A API do SNRJ permite que organizações autorizadas verifiquem se uma pessoa está na lista de auto-exclusão do sistema. Esta verificação é feita através do CPF da pessoa.
Obtendo Acesso
Para obter acesso à API, siga os seguintes passos:
- Crie uma conta empresarial no SNRJ
- Aguarde a aprovação da sua organização pela equipe do SNRJ
- Após aprovado, acesse o painel de controle para obter sua chave de API
Autenticação
Todas as requisições à API devem incluir sua chave de API no cabeçalho HTTPapikey.
Exemplo de Cabeçalho
apikey: "sua-chave-de-api-aqui"Endpoints
Verificar Auto-Exclusão por CPF
Endpoint:
GET /cpf/{documento}Parâmetros:
documento: CPF da pessoa (apenas números)
Exemplo de Requisição:
curl -X GET "https://api.snrj.gov.br/cpf/12345678900" \
-H "apikey: sua-chave-de-api-aqui"Respostas Possíveis:
Pessoa auto-excluída (200 OK):
{
"email": "email@exemplo.com",
"phone": "(11) 98765-4321"
}Pessoa não encontrada (404 Not Found):
{
"message": "Pessoa não encontrada na lista de auto-exclusão"
}Erro de autenticação (401 Unauthorized):
{
"message": "Chave de API inválida ou não fornecida"
}Limites de Uso
Para garantir a qualidade do serviço, a API possui os seguintes limites:
- Máximo de 100 requisições por minuto por chave de API
- Máximo de 10.000 requisições por dia por chave de API
Suporte
Em caso de dúvidas ou problemas, entre em contato com nossa equipe de suporte através do email suporte@snrj.gov.br