Documentação da API

Nesta seção, você encontrará todas as informações relacionadas ao uso da API. Começando com os endpoints e logo mostrando as diferentes mensagens que podem ser retornadas. Em conjunto com as explicações e especificações de cada endpoint da API, há um simulador de requisição para que você possa testá-los e observar o comportamento.

Para começar a usar os endpoints, você deve solicitar seu token com o qual poderá fazer as solicitações desejadas nos diferentes playgrounds e em cada endpoint, há um parâmetro chamado "role". O parâmetro de função varia de acordo com a região.

  • Argentina
    role = zp
    
  • RESTO DA AMÉRICA LATINA
    role = rela
    
  • Brasil
    role = br
    

O token deve ser inserido em cada solicitação para ser executado. Para obter o mesmo, você deve executar as seguintes etapas:

  1. Vá para a seção de Endpoints da API
  2. Em seguida, acesse a subseção "authentication-application"
  3. Informe seus dados no Login do usuário e seu token será gerado.
IMPORTANTE
Ao inserir seus dados, no campo "grant_type" você deve preencher com "client_credentials".
BRA