Referência da API

Introdução à API

Primeiros passos com a API do Flowsery Analytics

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 de API deve incluir o cabecalho <code>Authorization</code> usando o esquema Bearer. Substitua <code>YOUR_API_KEY</code> pela chave que voce criou.

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": { ... }
}

Respostas de erro retornam o codigo de status HTTP correspondente (4xx ou 5xx) com um corpo como:

Resposta de erro
{
  "status": "error",
  "error": {
    "code": "HTTP_STATUS_CODE",
    "message": "A descriptive error message"
  }
}

Codigos de erro padrao

<strong>400 Bad Request</strong> -- A entrada e invalida ou parametros obrigatorios estao ausentes.<br /><strong>401 Unauthorized</strong> -- A chave API esta ausente ou e invalida.<br /><strong>404 Not Found</strong> -- O recurso solicitado nao existe.<br /><strong>500 Internal Server Error</strong> -- Ocorreu um problema inesperado no servidor.