Nossa API autentica os usuários por meio de uma chave da API. Essa chave é essencial para que nosso sistema reconheça sua conta, facilitando a comunicação conosco em nome dela.

Se a chave de API for inválida, não for fornecida ou se o cabeçalho estiver incorreto, nossa API responderá com o código de status HTTP 401.

🚧

Atenção:

Depois de gerar a chave de API em nossa interface, recomendamos armazená-la diretamente em seu cofre de chaves. Isso evita que a chave seja exposta em mensagens de qualquer tipo ou e-mails. Nunca deixe a chave de API diretamente no código-fonte de seus sistemas.

Evite compartilhar sua chave de API em conversas, com terceiros ou expô-la no front-end de sua aplicação. Certifique-se de que sua aplicação não registre a chave em logs do sistema.

Se o seu time de desenvolvimento usar a chave de API de Produção nos ambientes de desenvolvimento ou homologação durante os testes finais da integração, é crucial renová-la antes de entrar em produção. Isso garante que o menor número possível de pessoas tenha acesso à chave.

Utilize pelo menos um dos mecanismos adicionais de segurança descritos aqui.

A chave de API é irrecuperável, caso seja perdida, é necessário a geração de uma nova.

Utilize os headers abaixo em todas as suas chamadas para a API

"Content-Type": "application/json",
"X-Customer-Private-Key": "sua_api_key",
"accept": "application/json"

👍

Aviso:

As chaves de API são diferentes nos ambientes de Sandbox e Produção; assegure-se de atualizá-las ao modificar a URL.

Para adquirir sua Chave de API, por favor, acesse o dashboard em nossa interface web e siga para: Ajustes/Chaves da API