Autenticação à API

O método de autenticação disponível na API da plataforma de Pre-matching no Sandbox é o OAuth2 e HTTP padrão através de TOKEN JWT.

Para iniciar a comunicação com a plataforma e acessar as URLs protegidas da plataforma você necessitará recuperar um token de acesso válido.

Nas seções seguintes seguem alguns exemplos utilizando a aplicação cURL para o envio da requisição autenticada para exemplificar a solicitação de um token.

Nota: cURL é um aplicativo open source e não é suportado pelo Selic. Ele é citado apenas para demonstração das chamadas HTTP.

Recuperação/Solicitação de um token JWT para uso na API.

As variáveis são identificadas por ${}. Exemplo: ${client_id} é a variável que identifica o cliente da API da sua instituição, como por exemplo "desenv" nos ambientes de desenvolvimento. Ex

            curl -X POST \
            https://api.sandbox.selic.gov.br/auth/realms/logon/protocol/openid-connect/token \
            -H 'Accept: */*' \
            -H 'Content-Type: application/x-www-form-urlencoded' \
            -H 'Host: api.sandbox.selic.gov.br' \
            -d 'grant_type=client_credentials&client_id=${client_id}&client_secret=${client_secret}'
        

Simulação de envio (Request)

        curl -X POST \
        https://api.sandbox.selic.gov.br/auth/realms/logon/protocol/openid-connect/token \
        -H 'Accept: */*' \
        -H 'Content-Type: application/x-www-form-urlencoded' \
        -H 'Host: api.sandbox.selic.gov.br' \
        -d 'grant_type=client_credentials&client_id=desenv&client_secret=secret'
      

Simulação de comunicação à API

Após recuperação do TOKEN válido, você deve utilizá-lo nas chamadas à API, seguindo o exemplo abaixo

        curl -X GET \
        https://api.sandbox.selic.gov.br/pre-matching/api/v2/negocios/202004010000001 \
        -H "accept: application/json" \
        -H 'Authorization: Bearer eyJhbGciOiJ...ctSsFxQ' \
        -H 'Host: api.sandbox.selic.gov.br'
      

Rate Limiting – Limitação de requisições

A política de limitação (rate-limiting) funciona com base em cabeçalhos enviados na requisição. Todas as requisições de consulta, geração e atualização de TOKENS serão limitadas.

Portanto, atente-se a configuração do seu cliente da API evitando bloqueios de acesso à plataforma causada por excesso de requisições.

Inicialmente a pltaforma permitirá até 100 requisições por minuto.

As respostas do cabeçalho HTTP de qualquer requisição à API mostrarão o status atual do seu limite de requisições permitidas. Exemplo:

            curl -X GET \
            https://api.sandbox.selic.gov.br/pre-matching/api/v2/negocios/202004010000001 \
            -H "accept: application/json" \
            -H 'Authorization: Bearer eyJhbGciOiJ...ctSsFxQ' \
            -H 'Host: api.sandbox.selic.gov.br'
            HTTP/1.1 200 OK
            Date: Mon, 13 Jul 2020 09:27:06 GMT
            Status: 200 O
            RateLimit-Limit: 100
            RateLimit-Remaining: 10
            RateLimit-Reset: 60
      

Descrição:

Caso sua aplicação cliente exceda este limite, ela receberá um HTTP STATUS 429 informando que o limite máximo permitido foi ultrapassado. Exemplo:

        GET /obter-status/123
        Response:
        HTTP/1.1 429 Too Many Requests
        Content-Type: application/json
        Date: Mon, 13 Jul 2020 09:27:40 GMT
        Retry-After: Mon, 13 Jul 2020 09:27:40 GMT
        
        RateLimit-Limit: 100
        Ratelimit-Remaining: 0
        RateLimit-Reset: 60
        {
        "title": "Too Many Requests",
        "status": 429,
        "detail": "Você ultrapassou o número de requisições permitidas"
      }
      

Cenários de testes disponíveis (Mock)

Nem todas as funcionalidades se encontram disponíveis neste ambiente de sandbox. Abaixo você encontra todos os cenários possíveis de serem testados e detalhes de como eles devem ser realizados.

Clique aqui para efetuar o download da collection para o Postman com os cenários disponíveis (As requisições precisam ser idênticas aos exemplos contidos nas coleções. Caso contrário, as respostas retornarão erro HTTP).