Pular para o conteúdo principal

​
Autenticação por Chave de API

A API First Answer usa chaves de API para autenticar requisições. Toda requisição aos endpoints /v1/ deve incluir uma chave de API válida nos cabeçalhos da requisição. 
curl -H "api-key: SUA_CHAVE_API" \
  https://api.firstanswer.ai/v1/brands/
Chaves de API concedem acesso aos dados da sua conta. Mantenha-as seguras e nunca as exponha em código client-side, repositórios públicos ou requisições do navegador.

​
Obtendo uma Chave de API

1

Navegue até as configurações de API

Faça login na plataforma First Answer e acesse Configurações → Chaves de API.
2

Crie uma nova chave

Clique em Criar Chave de API e dê um nome descritivo (ex: “Dashboard de Produção”, “Analytics Interno”).
3

Copie sua chave

Sua chave de API será exibida apenas uma vez. Copie-a e armazene-a com segurança. Se você perdê-la, precisará gerar uma nova.

​
Usando Sua Chave de API

Inclua a chave de API no cabeçalho api-key de cada requisição: 
curl -H "api-key: SUA_CHAVE_API" \
  https://api.firstanswer.ai/v1/brands/

​
Expiração da Chave

Chaves de API são válidas por 6 meses a partir da data de criação. Após a expiração, requisições feitas com a chave retornarão um erro 401: 
{
  "error": {
    "code": "AUTHENTICATION_FAILED",
    "message": "API key has expired."
  }
}
Gere uma nova chave antes que a atual expire para evitar interrupções no serviço.

​
Respostas de Erro

​
Chave de API Ausente

Se nenhum cabeçalho api-key for fornecido, a API retornará:
401
{
  "error": {
    "code": "AUTHENTICATION_FAILED",
    "message": "Authentication credentials were not provided."
  }
}

​
Chave de API Inválida

Se a chave estiver incorreta ou tiver sido revogada:
401
{
  "error": {
    "code": "AUTHENTICATION_FAILED",
    "message": "Invalid or inactive API key."
  }
}

​
Chave de API Expirada

Se a chave passou da data de expiração:
401
{
  "error": {
    "code": "AUTHENTICATION_FAILED",
    "message": "API key has expired."
  }
}

​
Boas Práticas

Nunca insira chaves de API diretamente no código-fonte. Armazene-as como variáveis de ambiente:
export FIRSTANSWER_API_KEY="sua-chave-aqui"

import os
api_key = os.environ["FIRSTANSWER_API_KEY"]
Não espere as chaves expirarem. Crie uma nova chave, atualize suas integrações e depois revogue a antiga.
Nomeie suas chaves de acordo com seu propósito (ex: “Dashboard Looker”, “Bot Slack Interno”) para que você possa gerenciá-las e revogá-las facilmente.
Se uma chave não é mais necessária, revogue-a imediatamente nas configurações de API. Isso previne acessos não autorizados.
Chaves de API devem ser usadas apenas em código server-side. Nunca as inclua em JavaScript frontend, aplicativos mobile ou qualquer código acessível publicamente.