ACCESS_TOKEN - Como gerar o access_token

Obtenção do Access Token

Para acessar os endpoints protegidos da API, é necessário gerar um access token utilizando o consumer_key, consumer_secret e o code obtido nas etapas anteriores.

Corpo da requisição

  • consumer_key: Sua consumer_key fornecida pela Vindi.
  • consumer_secret: Seu consumer_secret fornecido pela Vindi.
  • code: Código obtido no passo de autorização via URL (authorization code).
  • type_response: Define o formato do retorno. Use "J" para JSON; se não for informado, o retorno será em XML.

Exemplo de requisição (JSON):

{
    "consumer_key": "SEU_CONSUMER_KEY",
    "consumer_secret": "SEU_CONSUMER_SECRET",
    "code": "SEU_CODE",
    "type_response": "J"
}

Retorno da requisição

Se a operação for bem-sucedida, o retorno conterá os tokens de autorização, com suas respectivas datas de expiração.

Exemplo de retorno (JSON):

{
    "message_response": {
        "message": "success"
    },
    "data_response": {
        "authorization": {
            "access_token": "92e59a310402dd5b0e585430b5eb998083c2b8c7601c94dfda2ab6fcc9d6b8cb",
            "access_token_expiration": "2025-12-30T16:38:13.053-03:00",
            "refresh_token": "71d06f17ea947af8603e5b59d5048f6b",
            "refresh_token_expiration": "2026-03-29T16:38:13.053-03:00"
        }
    }
}

Descrição dos campos do retorno

  • access_token: Token que deve ser usado nas chamadas aos endpoints protegidos da API.
  • access_token_expiration: Data e hora em que o access token expira. Após essa data, será necessário gerar um novo token.
  • refresh_token: Token utilizado para renovar o access token sem precisar passar pelo fluxo de autorização novamente.
  • refresh_token_expiration: Data e hora em que o refresh token expira. Após essa data, será necessário gerar um access_token code e refazer o processo de autorização.
Language
Response
Click Try It! to start a request and see the response here!