api-reference

1. Crear una clave API

Dirijase a la Configuracion de su sitio > pestana API dentro del panel de Flowsery Analytics. Genere una nueva clave API. Copiela de inmediato, ya que no se mostrara de nuevo. Trate sus claves API como contrasenas: almacenelas de forma segura y nunca las exponga en codigo del lado del cliente ni en repositorios publicos. Todas las claves usan el prefijo <code>flow_</code> (por ejemplo, <code>flow_sk_live_abc123</code>).

2. Autenticar sus solicitudes

Cada llamada API debe incluir el encabezado de Autorización utilizando el esquema Portador. Las claves API deben comenzar con el prefijo flow_.

Encabezado de autorizacion
Authorization: Bearer YOUR_API_KEY

3. Comenzar a hacer solicitudes

La URL base para todos los endpoints v1 es: <code>https://analytics.flowsery.com/api/v1/</code>

Formato de respuesta

Las respuestas exitosas devuelven un estado 200 OK con un cuerpo estructurado asi:

Respuesta exitosa
{
  "status": "success",
  "data": { ... }
}

Los errores utilizan la forma de respuesta de error HTTP normal de NestJS.

Respuesta de error
{
  "message": "Unauthorized",
  "statusCode": 401
}

Codigos de error estandar

<strong>400 Solicitud incorrecta</strong>: la entrada no es válida o faltan parámetros requeridos.<br /><strong>401 No autorizado</strong>: la clave API falta, no es válida o no comienza con flow_.<br /><strong>404 No encontrado</strong>: el recurso solicitado no existe.<br /><strong>Error interno del servidor 500</strong>: se produjo un problema inesperado en el servidor.
Solicitud de ejemplo (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
    }
  ]
}