Pular para o conteúdo principal

Autenticação

Como obter a api key

Url dos ambientes abaixo

Acesse pela plataforma por um dos ambientes disponíveis.

  1. Vá para seção Configuração > Controle de Acesso
  2. Selecione o seu usuário, ou crie um novo
  3. Navegue até o fim da página, na seção Integração via API do usuário
  4. Crie ou copie sua api key para começar a usar
Atenção
  • Sua API Key carrega muitos privilégios, portanto certifique-se de mantê-la protegida.

Não informe ela em atendimentos e nem a exponha no front-end da sua aplicação.

Para autenticação você deve usar uma API-Key específica, este método só está disponível se você fornecer os endereços IP de seu servidor.

A API-Key precisa estar presente no cabeçalho de autorização como um RFC 6750 Bearer Token. Ex.: Bearer: API-KEY or Bearer: access_token

Security Scheme TypeHTTP
HTTP Authorization Schemebearer
Bearer format"API-Key"