Autenticação
O objetivo da autenticação é garantir que apenas integradores autorizados tenham acesso aos recursos e funcionalidades disponibilizados pela API de Pix.
O método de autenticação para a API de Pix é por meio de um token de acesso, que utiliza o padrão OAuth 2.0, com um tempo de vida de 8 horas, que garante ao integrador acesso às funcionalidades de forma segura.
Etapa 1: solicitar credenciais de acesso
Para que possa realizar a integração, é preciso solicitar junto ao time de integração da MT Bank o ClientId , ClientSecret e Scope, para que com estas informações possa ser possível gerar o token JWT.
Etapa 2: solicitar a autorização
Em posse das informações necessárias, conforme indicado na etapa 1, poderá ser gerado o token de acesso no padrão OAuth 2.0, tornando possível o acesso às APIs da MT Bank. Para tal, é necessário utilizar a API de Autenticação, que gerará o token, que deverá ser utilizado até a expiração do seu tempo de vida.
Veja a API Gerar Token de Acesso.
Etapa 3: utilização do token
Em posse do token gerado, deverá enviá-lo no cabeçalho da solicitação da API, conforme o exemplo abaixo:
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL3NlcnZpbmRlci1hdXRvcml6YWNpb24uY29tIiwic3ViIjoiaWQtZG8tdXN1YXJpbyIsImF1ZCI6ImNsaWVudGUtaWQiLCJpYXQiOjE2NDE5MDQ4MDAsImV4cCI6MTY0MTkwODQwMCwic2NvcGUiOiJsZWF1dGEgZXNjcml0YSIsImlhdCI6MTY0MTkwNDgwMH0.LsJ0-8D7Pw40T4dODCMLz4MNt3XVbwbPKUSe_9hFn8E
POST Gerar token de acesso
{{auth-url}}token
Retorna o token de acesso, utilizado para autenticação das APIs.
O método de autenticação utilizado é o Basic, que consiste em um método simples de autenticação em que o nome de usuário e a senha, convertidos em Base64, são enviados como parte do cabeçalho da solicitação.
Para converter em Base64, é necessario concatenar o usuário e senha, tendo como separador o caracter ":".
Exemplo:
ClientId : "cliente-teste"
ClientSecret : "segredo-teste"
Texto concatenado: "cliente-teste:segredo-teste".
Base64: "Y2xpZW50ZS10ZXN0ZTpzZWdyZWRvLXRlc3Rl" (conversor texto para Base64).
Authorization Basic Auth
| Campo | Valor |
|---|---|
| Username | Nome do usuário |
| Password | Senha |
Body urlencoded
| Parâmetro | Valor | Descrição |
|---|---|---|
| grant_type | client_credentials | Tipo de concessão do token. Utilizar "client_credentials". |
| client_id | client_secret_teste | Número identificador do cliente, fornecido pela MT Bank. |
| scope | clients_api/big_pix | São ações que podem ser realizadas com base nos escopos enviados pela MT Bank. É composto por "servidor_de_recurso/recurso". |
Example
Sucesso
Request
"method": "POST" "https://sandbox-token.mtbank.com.br/oauth2/token",\
//"headers":"Content-Type": "application/x-www-form-urlencoded",\
//"Host": ""\
//"body": ""Response
{
"access_token": "eyJraWQiOiJIYjF3WlNpOEhIS0xsaDVNTGZSSTVaZkhSZDltSVJUUXJaZzc4WEV0T1dzPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiI3dDI1djI0b3Y5OXQ5dnFnZWdpdm9xOHU2NiIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiY2xpZW50c19hcGlcL2JpZ19waXgiLCJhdXRoX3RpbWUiOjE3NjA1NDA0MDEsImlzcyI6Imh0dHBzOlwvXC9jb2duaXRvLWlkcC5zYS1lYXN0LTEuYW1hem9uYXdzLmNvbVwvc2EtZWFzdC0xX2VFQkFkeTNNSiIsImV4cCI6MTc2MDU0MDcwMSwiaWF0IjoxNzYwNTQwNDAxLCJ2ZXJzaW9uIjoyLCJqdGkiOiJmNmI3NTFlZS1lYjFmLTQ3ZTMtYTgyMi04ZTJjOTRkYTYxNTUiLCJjbGllbnRfaWQiOiI3dDI1djI0b3Y5OXQ5dnFnZWdpdm9xOHU2NiJ9.Ifm99rTF9jfyy_WzvURaEJkpk_KVmF6X5u1E2wYluWz",
"expires_in": 300,
"token_type": "Bearer"
}