🔑 Autenticação

Chave de API

Para utilizar nossa API, é necessário realizar a autenticação utilizando um Token denominado "Chave da API".

Como obter sua chave

Cada cliente deve gerar sua própria chave dentro da ferramenta clicando em [Nome do Usuário] -> Chaves da API.

Autenticação

Nas chamadas dos comandos da API utilize o parâmetro APIKey como chave de autenticação

Parâmetros comuns a todas as chamadas

Estes parâmetros valem para qualquer comando da API, e por isso não são repetidos na página de cada endpoint:

ParâmetroObrigatórioDescrição
APIKeySimChave de autenticação da conta
CommandSimNome do comando a ser executado (ex.: Subscriber.Subscribe)
ResponseFormatSimFormato do retorno (ex.: JSON)
SessionIDNãoID de sessão. Necessário apenas para aplicações desktop
JSONPCallBackNãoEnvie em caso de requisição cross-domain

As requisições podem ser enviadas via POST ou GET. Se houver dados em POST, eles têm precedência sobre a query string.

⚠️ Sensibilidade a maiúsculas e minúsculas

  • Nomes de parâmetro não diferenciam maiúsculas de minúsculas. APIKey, apikey e ApiKey são equivalentes — a API converte todos os nomes recebidos para minúsculas.
  • O valor de Command diferencia. Ele é comparado por igualdade exata: Lists.Delete funciona, lists.delete ou List.Delete não. Um Command incorreto não retorna erro — a resposta vem vazia, porque nenhum comando foi reconhecido. Confira sempre o nome exato na página do endpoint.

Segurança

SSL 🔒

Recomendação: Para maior segurança, sempre utilize conexões HTTPS em ambiente de produção.


Did this page help you?