Referencia API

Referencia Completa

Referencia completa de todos los eventos que admite la API de seguimiento de eventos de InfiniAnalytics -START, EVENT, WARNING, ERROR y END - todos enviados a través del mismo POST /v1/register/ endpoint.

Descripción

La API de InfiniAnalytics te permite hacer seguimiento de las ejecuciones de los procesos automatizados de tu organización. Una ejecución se construye a partir de los siguientes eventos:

START - registra el inicio de la ejecución de un automatismo.
EVENT - registra un evento relevante durante la ejecución.
WARNING - registra una advertencia ocurrida durante la ejecución.
END - registra el fin de la ejecución.
ERROR - registra un fallo o excepción ocurrido durante la ejecución.

Esto te da un registro detallado y consultable de todo lo que ocurre en cada automatismo de tu organización, tanto para la monitorización en tiempo real como para auditorías posteriores.

Primeros Pasos

Consigue tu token de organización - una cadena secreta usada para autenticar cada endpoint. Puedes encontrarla en el panel de InfiniAnalytics, en la página donde se gestiona tu organización.
Identifica tu automatismo - cada evento se asocia a un automatismo a través de su identificador único, automation_id. Si no lo tienes, pregunta a tu administrador de plataforma o consulta tu listado de automatismos.
Decide un execution_id para la ejecución - un valor que identifique de forma única la ejecución que estás iniciando. Debe ser único y no puede reutilizarse en dos ejecuciones concurrentes. Puede ser un ID que ya uses internamente, o una marca de tiempo de la fecha/hora en que empieza la ejecución.
Haz las peticiones por HTTPS - envía los datos a los endpoints por HTTPS para mantener la comunicación segura. Cualquier petición HTTP plana devuelve un HTTP 301 que te redirige a la versión HTTPS.
Envía y gestiona tus eventos - usa el endpoint principal /v1/register/ para registrar los distintos tipos de evento de tu ejecución (START, EVENT, WARNING, END, ERROR). Si quieres comprobar la conectividad con la API antes de empezar, llama a /v1/ping/.

Autenticación

La API de InfiniAnalytics requiere un token de organización en cada llamada a los endpoints. Toda petición POST a /v1/register/ debe incluir una cabecera token con el valor de tu token de organización. Sin este token, o con uno inválido, recibirás un HTTP 401 Unauthorized.

Ejemplo de cabecera:

http

token: your_organization_token
Content-Type: application/json

Errores del Servidor

Un HTTP 500 o algo similar indica que el servidor está experimentando una carga inusualmente alta o un problema temporal. Si persiste, o recibes otros 5XX errores, contacta con el soporte de InfiniAnalytics.

Registrar inicio de ejecución

POST/v1/register/

Registra el inicio de una ejecución. Debe ser el primer evento enviado para un execution_id.

Campos del cuerpo de la petición

Campo	Obligatorio	Descripción
`automation_id`	Sí	El UUID de tu automatismo en la plataforma InfiniAnalytics.
`execution_id`	Sí	Identificador único de la ejecución que estás iniciando. Puede ser tu propio ID de sistema o una marca de tiempo.
`event`	Sí	Tipo de evento a registrar, en este caso `START`.
`description`	No	Texto libre que describe la ejecución que está empezando.

Ejemplo de cuerpo de la petición:

json

{
  "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "event": "START",
  "description": "Starting the execution"
}

Ejemplo de petición cURL:

bash

curl --location 'https://api.analytics.infini.es/v1/register/' \
  --header 'Content-Type: application/json' \
  --header 'token: your_organization_token' \
  --data '{
    "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
    "execution_id": "2025-03-03T15:32:17.571404",
    "event": "START",
    "description": "Starting the execution"
  }'

Ejemplo de respuesta (HTTP 201):

json

{
  "automation": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "type_of_event": "START",
  "description": "Starting the execution",
  "error_id": "",
  "error_description_detail": "",
  "created_at": "2025-03-03T16:00:29.998530Z"
}

Registrar evento de ejecución

POST/v1/register/

Registra un evento relevante ocurrido durante la ejecución - útil para registrar el progreso o hitos intermedios, sin marcar la ejecución como finalizada, con advertencia o fallida.

Campos del cuerpo de la petición

Campo	Obligatorio	Descripción
`automation_id`	Sí	El UUID de tu automatismo en la plataforma InfiniAnalytics.
`execution_id`	Sí	Identificador único de la ejecución. Debe coincidir con el execution_id usado en su evento START.
`event`	Sí	Tipo de evento a registrar, en este caso `EVENT`.
`description`	No	Texto libre que describe el evento.

Ejemplo de cuerpo de la petición:

json

{
  "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "event": "EVENT",
  "description": "Relevant event description"
}

Ejemplo de petición cURL:

bash

curl --location 'https://api.analytics.infini.es/v1/register/' \
  --header 'Content-Type: application/json' \
  --header 'token: your_organization_token' \
  --data '{
    "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
    "execution_id": "2025-03-03T15:32:17.571404",
    "event": "EVENT",
    "description": "Relevant event description"
  }'

Ejemplo de respuesta (HTTP 201):

json

{
  "automation": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "type_of_event": "EVENT",
  "description": "Relevant event description",
  "error_id": "",
  "error_description_detail": "",
  "created_at": "2025-03-03T16:00:29.998530Z"
}

Registrar advertencia de ejecución

POST/v1/register/

Registra advertencias que pueden ocurrir en tu automatismo - no lo bastante graves como para hacer fallar la ejecución, pero que merece la pena registrar.

Campos del cuerpo de la petición

Campo	Obligatorio	Descripción
`automation_id`	Sí	Debe ser el ID de tu automatismo, en formato UUID.
`execution_id`	Sí	Identificador único de la ejecución. Puede ser tu propio ID de sistema o una marca de tiempo.
`event`	Sí	Tipo de evento a registrar, en este caso `WARNING`.
`description`	No	Texto que describe la advertencia a registrar.

Ejemplo de cuerpo de la petición:

json

{
  "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "event": "WARNING",
  "description": "Warning description"
}

Ejemplo de petición cURL:

bash

curl --location 'https://api.analytics.infini.es/v1/register/' \
  --header 'Content-Type: application/json' \
  --header 'token: your_organization_token' \
  --data '{
    "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
    "execution_id": "2025-03-03T15:32:17.571404",
    "event": "WARNING",
    "description": "Warning description"
  }'

Ejemplo de respuesta (HTTP 201):

json

{
  "automation": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "type_of_event": "WARNING",
  "description": "Warning description",
  "error_id": "",
  "error_description_detail": "",
  "created_at": "2025-03-03T16:00:29.998530Z"
}

Registrar error de ejecución

POST/v1/register/

Registra errores que pueden ocurrir en tu automatismo. Registrar un error en una ejecución hace que se contabilice como fallida.

Campos del cuerpo de la petición

Campo	Obligatorio	Descripción
`automation_id`	Sí	Debe ser el ID de tu automatismo, en formato UUID.
`execution_id`	Sí	Identificador único de la ejecución. Puede ser tu propio ID de sistema o una marca de tiempo.
`event`	Sí	Tipo de evento a registrar, en este caso `ERROR`.
`description`	No	Texto que describe la ejecución a alto nivel.
`error_id`	No	Un identificador de error, si lo hay. Puede introducirse manualmente o de forma automática si tu lenguaje o plataforma lo permite.
`error_description`	No	Mensaje de error detallado, normalmente proporcionado por el lenguaje o la plataforma de tu automatismo.

Ejemplo de cuerpo de la petición:

json

{
  "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "event": "ERROR",
  "description": "High-level error description",
  "error_id": "e0001",
  "error_description": "Detailed error description"
}

Ejemplo de petición cURL:

bash

curl --location 'https://api.analytics.infini.es/v1/register/' \
  --header 'Content-Type: application/json' \
  --header 'token: your_organization_token' \
  --data '{
    "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
    "execution_id": "2025-03-03T15:32:17.571404",
    "event": "ERROR",
    "description": "High-level error description",
    "error_id": "e0001",
    "error_description": "Detailed error description"
  }'

Ejemplo de respuesta (HTTP 201):

json

{
  "automation": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "type_of_event": "ERROR",
  "description": "High-level error description",
  "error_id": "e0001",
  "error_description_detail": "Detailed error description",
  "created_at": "2025-03-03T16:00:29.998530Z"
}

Registrar fin de ejecución

POST/v1/register/

Registra el fin de una ejecución. Si el evento ERROR no se registró previamente, la ejecución se contabiliza como exitosa.

Campos del cuerpo de la petición

Campo	Obligatorio	Descripción
`automation_id`	Sí	Debe ser el ID de tu automatismo, en formato UUID.
`execution_id`	Sí	Identificador único de la ejecución. Puede ser tu propio ID de sistema o una marca de tiempo.
`event`	Sí	Tipo de evento a registrar, en este caso `END`.
`description`	No	Texto que describe la ejecución que está finalizando.

Ejemplo de cuerpo de la petición:

json

{
  "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "event": "END",
  "description": "End of execution description"
}

Ejemplo de petición cURL:

bash

curl --location 'https://api.analytics.infini.es/v1/register/' \
  --header 'Content-Type: application/json' \
  --header 'token: your_organization_token' \
  --data '{
    "automation_id": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
    "execution_id": "2025-03-03T15:32:17.571404",
    "event": "END",
    "description": "End of execution description"
  }'

Ejemplo de respuesta (HTTP 201):

json

{
  "automation": "3571c1e0-88b9-4104-a0b0-f060b7fcc6eb",
  "execution_id": "2025-03-03T15:32:17.571404",
  "type_of_event": "END",
  "description": "End of execution description",
  "error_id": "",
  "error_description_detail": "",
  "created_at": "2025-03-03T16:00:29.998530Z"
}