OAuth2 - Authorization Code

Authorization Code Request

A aplicação que está realizando a integração deve redirecionar o usuário para uma URL construída no seguinte formato:

Parâmetros da requisição (na query string, método GET):

GET https://api.birdid.com.br/v0/oauth/authorize

Query Parameters

Name	Type	Description
login_hint	string	Valor de CPF ou CNPJ a ser informado como filtro para seleção do certificado a ser utilizado. Por ser do tipo string, preencha com zeros à esquerda (11 dígitos para CPF e 14 dígitos para CNPJ).
code_challenge_method	string	Fixo: "S256", veja RFC 7636
code_challenge	string	Veja RFC 7636
response_type	string	Fixo: "code".
client_id	string	Deve ter a identificação da aplicação.
redirect_uri	string	Deve ter a URI para redirecionar o usuário de volta para a aplicação de origem. A URI deve estar na lista de URI's autorizadas para a aplicação. Deve ser URL ENCODED. Se não informado, será considerada a primeira URI cadastrada para a aplicação.
state	string	É retornado sem modificações para aplicação de origem.
lifetime	number	Indica o tempo de vida desejado para o token de autorização. Inteiro, em segundos.
scope	string	Se não informado, será considerado "authentication_session".

200

O usuário será redirecionado para página da solução onde as credenciais deverão ser informadas, após a devida autenticação e autorização o usuário é redirecionado para a página apontada pelo cliente da solução.

Retorno:

O usuário é redirecionado para redirect_uri com dois parâmetros na query string: code (o código de autorização a ser usado na solicitação do token) e state (da mesma forma que informado na requisição inicial).

Exchange Code for Access Token

Após o usuário ser direcionado de volta para aplicação de origem, a aplicação que está realizando a integração deverá consumir em background o endpoint para recuperar o token OAuth.

Parâmetros da requisição:

POST https://api.birdid.com.br/v0/oauth/token

Headers

Name	Type	Description
Content-Type	string	application/json
Accept	string	application/json

Request Body

Name	Type	Description
code_verifier	string	Veja RFC 7636
redirect_uri	string	URL de redirecionamento
client_id	string	Deve ter a identificação da aplicação.
client_secret	string	Deve ter o secret da aplicação
code	string	Deve ter o code
grant_type	string	Fixo: "authorization_code"
lifetime	number	Indica o tempo de vida desejado para o token a ser gerado. Inteiro, em segundos.

200

{
	"access_token": "b923575f1ced0ee732ee274b2e02784040bd9606",
	"expires_in": 300,
	"token_type": "Bearer",
	"authorized_identification_type": "CPF",
	"authorized_identification": "00000000001"
}