Referencia API

Introducción a la API

Primeros pasos con la API de Flowsery Analytics

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 a la API debe incluir el encabezado <code>Authorization</code> usando el esquema Bearer. Sustituya <code>YOUR_API_KEY</code> por la clave que creo.

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

Las respuestas de error devuelven el codigo de estado HTTP correspondiente (4xx o 5xx) con un cuerpo como:

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

Codigos de error estandar

<strong>400 Bad Request</strong> -- La entrada es invalida o faltan parametros obligatorios.<br /><strong>401 Unauthorized</strong> -- La clave API falta o es invalida.<br /><strong>404 Not Found</strong> -- El recurso solicitado no existe.<br /><strong>500 Internal Server Error</strong> -- Ocurrio un problema inesperado en el servidor.