Autenticação

A autenticação na nossa API é realizada por meio de uma chave de acesso (X-Token-Api). É com ela que conseguimos identificar sua conta e autorizar as operações realizadas em seu nome.

Se a chave informada for inválida, estiver ausente ou enviada em um header incorreto, a API retornará o status HTTP 401 (não autorizado).

A proteção dessa chave é de total responsabilidade do cliente. Para aumentar a segurança, recomendamos a utilização de camadas adicionais, como a restrição de acesso por endereços IP confiáveis.

⚠️ Importante:

Depois de gerar sua chave de API na plataforma, evite compartilhá-la em e-mails, mensagens ou qualquer outro canal. Nunca insira a chave diretamente no código-fonte de seus sistemas nem a exponha em atendimentos, no front-end da aplicação ou em registros de log.

Você poderá resgatar essa chave novamente a qualquer momento dentro do portal.

Cabeçalhos nas requisições

Toda requisição deve conter o seguinte cabeçalho para autenticação:

"Content-Type": "application/json",
"X-Token-Api": "sua_api_key"

Ambientes de Sandbox e Produção

As chaves de API dos ambientes de Sandbox e Produção são distintas, então lembre-se de atualizar a chave corretamente de acordo com o ambiente utilizado.

Veja no link abaixo como obter seu Token de API:

Como obter o Token de API

URLs de Sandbox e Produção

Ambiente	URL
Produção	https://api.barte.com
Sandbox	https://sandbox-api.barte.com

Protocolo de segurança TLS (Transport Layer Security)

Atualmente, nosso sistema está configurado para receber comunicações TLS 1.2+.

Erro de autenticação

O status 401 Unauthorized significa que a requisição não foi autenticada com sucesso. Para facilitar a identificação da causa, a API retorna no corpo da resposta uma mensagem de erro descritiva, indicando o motivo específico em cada situação.

{
  "errors": [
    {
      "code": "BAR-3005",
      "title": "Token inativo ou inexistente.",
      "description": "Verifique se informou o x-token-api corretamente."
    }
  ]
}