API Reference

Autorização

Autorização

Todas as requisições podem ser autenticadas via método 'Bearer auth' enviando a chave Authorization no cabeçalho ou via query param adicionando o parâmetro api_token na url.

Access token

A chave de acesso (Access token) deve ser solicitada pelo cliente via canal de suporte.

⚠️ Atenção
Atualize sua chave de API com frequência. Manter a chave atualizada é fundamental para evitar seu uso indevido em caso de vazamento de informações. Não se esqueça de que sua chave de API funciona como uma senha, sendo ela responsável por autorizar suas requisições de forma automática e autenticada.

Bearer Auth

Siga os seguintes passos para gerar o cabeçalho de autenticação HTTP Bearer da requisição.

  • Solicite sua chave de API.
  • Adicione Bearer no início da chave, (não esqueça o espaço após a palavra Bearer).
  • Adicione o campo Authorization no cabeçalho da requisição.
  • Utilize a chave de API como valor do campo Authorization.
Exemplo
Authorization: "Bearer chave_de_api"

Não é necessário codificar a chave de API em base64 para enviar via Bearer Auth.


API Key

Siga os seguintes passos para gerar o parâmetro de consulta de autenticação API Key da requisição.

  • Solicite sua chave de API.
  • Adicione um parâmetro de consulta (query string) api_token na URL.
  • Atribua a API Key para esta api_token.
Exemplo
https://www.api2.webdanca.com/v1/endpoint?api_token=chave_de_api

Não é necessário codificar a chave de API em base64 para enviar via API Key.