api-reference

1. Criar uma chave API

Acesse as Configuracoes do seu site > aba API no painel do Flowsery Analytics. Gere uma nova chave API. Copie-a imediatamente pois nao sera exibida novamente. Trate suas chaves API como senhas -- armazene-as com seguranca e nunca as exponha em codigo do lado do cliente ou repositorios publicos. Todas as chaves usam o prefixo <code>flow_</code> (por ex. <code>flow_sk_live_abc123</code>).

2. Autenticar suas requisicoes

Cada chamada API deve incluir o cabeçalho Authorization utilizando o esquema Bearer. As chaves API devem começar com o prefixo flow_.

Cabecalho de autorizacao
Authorization: Bearer YOUR_API_KEY

3. Comecar a fazer requisicoes

A URL base para todos os endpoints v1 e: <code>https://analytics.flowsery.com/api/v1/</code>

Formato de resposta

Respostas bem-sucedidas retornam um status 200 OK com um corpo estruturado como:

Resposta bem-sucedida
{
  "status": "success",
  "data": { ... }
}

Os erros utilizam o formato normal de resposta de erros HTTP NestJS.

Resposta de erro
{
  "message": "Unauthorized",
  "statusCode": 401
}

Codigos de erro padrao

<strong>400 Bad Request</strong> -- A entrada é inválida ou faltam parâmetros obrigatórios.<br /><strong>401 Unauthorized</strong> -- A chave API está em falta, é inválida ou não começa com flow_.<br /><strong>404 Not Found</strong> -- O recurso solicitado não existe.<br /><strong>500 Internal Server Error</strong> -- Ocorreu um problema inesperado no servidor.
Exemplo de requisicao (curl)
curl --request GET \
  --url https://analytics.flowsery.com/api/v1/overview \
  --header 'Authorization: Bearer <api-key>'
200
{
  "status": "success",
  "data": [
    {
      "visitors": 12450,
      "sessions": 16890
    }
  ]
}