API Reference

Autenticação

Para invocar os endpoints da API API, você deve incluir o token Bearer no cabeçalho das solicitações de autorização. Use o cabeçalho Authorization com o valor Bearer <token>.

O token deve ser obtido utilizando-se o endpoint de login conforme apresentado abaixo.

Endpoint de Referência

  • POST /login

Cenário de Sucesso

O payload da request é simples, conforme visto nesta solicitação de exemplo.

{
    "accessKey" : "986d8167a9b9a15e37db4ab4ad50877b01347a94",
    "secret" : "79bPqahzbeYuIgyod1GBjsBy38wN7KuBBNNmN/emwjFCuAfq"
}
  • Campos da Request
CampoTipoRequeridoDescrição
accessKeystringtrueA chave de acesso criada no portal administrativo
secretstringtrueO segredo criado junto com a chave
  • Resposta de Sucesso (201 - Created)
eyJhbGciOiJIUzM4NCIsInR5cCI6IkpXVCJ9.eyB1aWQiOiI2NWQwZjVjOS03ZmIwLTQ1NWMtOTAzNi05ZTcyZjBhOGQwZjYiLCJhciI6WyJQYXJ0bmVyIiwiUGFydG5lckFkbWluIl0sImFrIjoiNDU3NzFlYTEtYjAxMi00YjgwLThiYTQtNDk4OTFjNWQ4ZDQ3IiwicmVhbG0iOiJQYXJ0bmVyIiwiY2EiOiIwZWE3MDAwMS0wZjU4LTQ0YTItODBhZC05NTM2MzNmZjJjYzciLCJjaWQiOiIyOTI2MzczOS0yY2Y4LTQ4M2QtYWYxNS02MTUxZGM4NDQ4YjQiLCJkb21haW4iOiIvcGFydG5lcnMtaW50IiwiaWF0IjoxNjkxMTUxMjU3LCJleHAiOjE2OTExNTQ4NTd9.wBdfxnNYap0_M-omZUmnor7lB6c3ooVK2AENYtsIcfLzofW5bvkYgQzhaVABtJsU

Cenários de Falha (Exemplos Úteis)

Cenário 1: Campo requerido vazio (secret)

{
    "accessKey" : "{{api_key}}"
}
  • Failure Response (400 - Bad Request)
{
  "statusCode": "Error",
  "error": {
    "name": "InvalidRequestFormatError",
    "message": "The request body is invalid. See error object `details` property for more info",
    "details": [
      {
        "path": "",
        "code": "required",
        "message": "must have required property 'secret'",
        "info": {
          "missingProperty": "secret"
        }
      }
    ]
  }
}

Cenário 2: Falha de Autenticação

Se a solicitação incluir uma chave inválida ou uma chave no estado Pending ou Expired, o seguinte erro será retornado.

  • Resposta de falha (401 - Unauthorized)
{
  "statusCode": "Error",
  "error": {
    "message": "Service was unable to complete your request.",
    "name": "AuthenticationError",
    "code": "AuthenticationError",
    "details": {
      "reason": "AccessKeyUnauthorized"
    }
  }
}