Skip to main content

API Keys

Introdução​

A autenticação via API Keys consiste no uso de uma chave secreta pré-gerada, única e persistente como token de autenticação enviada em cada requisição.

Uma API Key pode ser gerada na tela de API Keys no Painel Administrativo. Cada API Key gerada fica associada ao usuário que a criou e as permissões desse usuário.

tip

Cada API Key gerada é exibida apenas uma vez na sua criação! Tenha certeza de que você anotou ela após antes de sair da tela de criação!

Utilização​

Existem duas maneiras de enviar a chave e autenticar a sua requisição por meio de uma API Key:

tip

Lembre-se de que o token de autenticação (nesse caso a API Key) deve ser enviado em cada requisição

info

Onde estiver escrito <API Key> abaixo, substitua pela sua API Key.

  • HTTP Basic Auth​

    A API Key pode ser enviada por meio do padrão HTTP Basic Auth. Para isso, use o seguinte esquema:

    Usuário: apikey

    Senha: <API Key>

    Ou seja, o header Authentication Deve ser preenchido com:

    Authentication: Basic <string 'apikey:<API Key>' codificada em base64>

  • Nesse formato, a API Key pode ser enviada por meio do header X-API-Key como o valor desse header.

    X-API-Key: <API Key>
warning

Não utilize dois métodos de envio de autenticação simultâneamente! Isso resultará em uma resposta de erro com código 400!

warning

Se a API Key for expirada ou inválida, será retornado uma resposta de erro com stauts 401