Autenticação e Autorização

Autenticação:

Para fazer a Autenticação no sistema, é pré-requisito ter um BirdID de acordo com o ambiente que você está usando. No caso, se estiver em homologação, você precisa de um BirdID de homologação, se estiver usando produção, você precisa de um BirdID de produção. E também é necessário criar uma chave de API dentro do painel do BirdID para subistituir o OTP no momento da Autenticação.

circle-info

É possivel passar o OTP no momento da Autenticação, porém é inviável usar essa abordagem na integração entre sistemas.

POST /auth/birdid

Use este endpoint para conseguir o token de autenticação para passar no Header Authorization: Bearer "Token", das próximas requisições.

Headers:

Name
Value

Content-Type

application/json

Accept

application/json

Body:

Name
Type
Description

registration_number

string

Pode ser um CPF ou CNPJ (sem formatação)

password

string

Chave de API (ou o OTP)

Response:

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3...",
    "token_type": "Bearer",
    "expires_in": 86400
}

Autorização:

POST /auth/authorization

Use este endpoint para conseguir o token de Autorização. Ele será necessário ser passado no Header de todas as próximas requisições juntamente com o token de Autorização. Porém ele deverá constar no campo: x-spro-authorization: "Token" (sem o Bearer) de todas as requisições.

Headers:

Name
Value

Content-Type

application/json

Accept

application/json

Authorization

Bearer <token de Autenticação conseguido na requisição anterior>

Body: Vazio

Response:

Last updated