Autenticação

Recomendamos que para integração, crie um acesso de funcionário de visão geral, visando maior organização das suas solicitações, podendo separar o que foi solicitado via API e pelo seu funcionário de fato.

Para que você consiga realizar as solicitações protegidas, é necessário informar o token no cabeçalho da requisição conforme exemplificado no exemplo abaixo:

curl \
  --header "Content-Type: application/json" \
  --header "ApiKey: $API_KEY_TOKEN" \
  --request POST \
  https://example.com/

Criando uma API Key

Acesse a plataforma com o usuário que deseja autenticar em sua integração e acesso a tela de Configurações -> Chaves de API conforme apresentado na imagem abaixo:

As chaves de API possuem uma restrição por origem, visando garantir que as solicitações feitas com sua chave vieram de fonte segura e confiável.

Atenção

Para a realização de solicitações em ambiente de desenvolvimento informe seu IP externo ou VPN no campo de Origens