Ir para o conteúdo

Guias rápidos

Como autenticar na API Consulta CPF

As APIs disponibilizadas pela plataforma API SERPRO utilizam o protocolo OAuth2 para realizar a autenticação e autorização de acesso das APIs contratadas. Siga os passos abaixo para se autenticar e consumir essa API.

1. Primeiro passo - Obtenha Consumer Key e Consumer Secret

Para consumir as APIs, você deverá utilizar os dois códigos (Consumer Key e Consumer Secret) disponibilizados na Área do Cliente. Esses códigos servem para identificar o contrato. As credenciais de acesso devem ser obtidas a partir da área do cliente Serpro.

Exemplos de códigos: 

Consumer Key: djaR21PGoYp1iyK2n2ACOH9REdUb   
Consumer Secret: ObRsAJWOL4fv2Tp27D1vd8fB3Ote

Aviso importante

O Consumer Key e Consumer Secret identificam seu usuário e seu contrato com o SERPRO. Mantenha essas informações protegidas.

2. Segundo passo - Solicite o Bearer Token

Para consultar as APIs, é necessário obter um token de acesso temporário (Bearer). Esse token possui uma (1) hora de validade e, sempre que expirado, repita este passo de requisição de um novo token de acesso.

Como solicitar o Token de Acesso (Bearer)

Para solicitar o token temporário é necessário realizar uma requisição HTTP POST para o endpoint Token https://gateway.apiserpro.serpro.gov.br/token, informando as credenciais de acesso (consumerKey:consumerSecret) no HTTP Header Authorization, no formato base64, conforme exemplo abaixo. 

[HEAD] Authorization: Basic base64(Consumer Key:Consumer Secret) 
[HEAD] Content-Type: application/x-www-form-urlencoded 
[POST] grant_type=client_credentials

Para utilização no parâmetro Authorization, é necessário concatenar os códigos Consumer Key e Consumer Secret, separados pelo caracter ":", e converter o resultado em BASE64. No exemplo a seguir, é retornada a string ZGphUjIx[...]IzT3RlCg:

echo -n "djaR21PGoYp1iyK2n2ACOH9REdUb:ObRsAJWOL4fv2Tp27D1vd8fB3Ote" | base64

Resultado:

ZGphUjIxUEdvWXAxaXlLMm4yQUNPSDlSRWRVYjpPYlJzQUpXT0w0ZnYyVHAyN0QxdmQ4ZkIzT3RlCg

Abaixo segue um exemplo de chamada via cUrl:

curl -k -d "grant_type=client_credentials" \
-H "Authorization: Basic ZGphUjIxUEdvWXAxaXlLMm4yQUNPSDlSRWRVYjpPYlJzQUpXT0w0ZnYyVHAyN0QxdmQ4ZkIzT3RlCg" \
https://gateway.apiserpro.serpro.gov.br/token

Content-type

Caso experiencie erros de "415 Unsupported Media Type" na chamada de solicitação do Token, utilize o campo do Header "Content-Type" com o valor "application/x-www-form-urlencoded"

[HEAD] Content-type: "application/x-www-form-urlencoded"

3. Terceiro passo - Receba o Token

Como resultado do passo anterior, o endpoint informará o token de acesso a API, no campo access_token da mensagem json de retorno. Este token deve ser informado nos próximos passos. Fique atento ao tempo de renovação do Token de acesso.

Receba o Token

Como resultado, o endpoint informará o token de acesso a API, no campo access_token da mensagem json de retorno. Este token deve ser informado nos próximos passos.

{
    "scope": "am_application_scope default", 
    "token_type": "Bearer", 
    "expires_in": 3295, 
    "access_token": "c66a7def1c96f7008a0c397dc588b6d7"
}

Renovação do Token de Acesso

O token de acesso possui uma (1) hora de validade. Recomenda-se gerar um token de aceso por hora. Utilize o token de acesso até o momento que o gateway retorne um HTTP CODE 401 após realizar uma requisição para uma API. Para renovação do token, repita o Segundo Passo Como solicitar o Token de Acesso (Bearer).

4. Quarto passo - Fazendo uma requisição

Realizando consulta às APIs

De posse do Token de Acesso, faça a requisição a API CPF Trial. 

curl -X GET "https://gateway.apiserpro.serpro.gov.br/consulta-cpf-df-trial/v1/cpf/40442820135" \
-H "accept: application/json" \
-H "Authorization: Bearer 4e1a1858bdd584fdc077fb7d80f39283" \

No exemplo acima foram utilizados os seguintes parâmetros:

  • [HEADER] Accept: application/json
    Informamos o tipo de dados que estamos requerendo, nesse caso JSON

  • [HEADER] Authorization: Bearer 4e1a1858bdd584fdc077fb7d80f39283
    Informamos o token de acesso recebido

  • [GET] https://gateway.apiserpro.serpro.gov.br/consulta-cpf-df-trial/api/v1/cpf/40442820135
    Chamamos a url da API e o método desejado. No caso, a url base é "https://gateway.apiserpro.serpro.gov.br/consulta-cpf-df-trial/v1/”, e o método é o "cpf/40442820135".

Exemplo de resposta esperada:

{
    "ni":"40442820135",
    "nome":"Nome do CPF 404.428.201-35",
    "situacao": {
        "codigo":"0",
        "descricao":"Regular"
    },
    "nascimento":"14111970"
}

IMPORTANTE

A chamada à consulta da API CPF Trial acima é apenas para demonstração. As APIs disponíveis e suas respectivas URLs (endpoints) para consumo são disponibilizadas (através da documentação dos seus respectivos swaggers) na seção Referência da API. O gateway interpreta as letras maiúsculas e minúsculas de forma diferente. Certifique-se de enviar os endpoints conforme Referência da API sem alterar para maiúsculo ou minúsculo qualquer parte do endpoint.

Como utilizar a API CPF Demonstração

API CPF Demonstração é o ambiente de testes da API CPF, com dados de exemplo (Mock), com objetivo de demonstrar o funcionamento da API. Para utilizá-lo:

  1. Acesse o API CPF Demonstração
  2. Escolha o método (endpoint) a testar
  3. Clique em Try it Out
  4. Insira os cabeçalhos que desejar e/ou altere o conteúdo do corpo da requisição
  5. Clique em Execute

Dados para testes

Para testar o ambiente Trial, utilize um dos CPF fictícios listados abaixo.

CPF Situação Cadastral
40442820135 CPF Regular
63017285995 CPF Regular
91708635203 CPF Regular
58136053391 CPF Regular
40532176871 Suspensa
47123586964 Suspensa
07691852312 Pendente de Regularização
10975384600 Pendente de Regularização
01648527949 Cancelada por Multiplicidade
47893062592 Cancelada por Multiplicidade
98302514705 Nula
18025346790 Nula
64913872591 Cancelada de Ofício
52389071686 Cancelada de Ofício
05137518743 Titular Falecido
08849979878 Titular Falecido