Uso de la API

Uso de la API es un panel para quienes integran su sistema con Peakly por API. Muestra cuántas llamadas recibe tu organización, cuántas fallan y qué tan rápido responde la API, y te deja revisar cada request con lo que tu sistema envió y lo que Peakly respondió. Sirve para diagnosticar integraciones: por qué falló una factura, si un pedido llegó o si un endpoint está lento.

Cómo llegar

En el menú lateral, en el grupo Conectar, entrá a Desarrolladores > Uso de la API. También hay un acceso directo desde un comprobante creado por API: en el detalle del comprobante, dentro de los datos del ID externo, el enlace Ver pedidos a la API abre el panel con el explorador ya filtrado por ese pedido.

Elegir el período

Arriba a la derecha elegís el rango: Últimas 24 h, 7 días, 30 días o Personalizado (un selector de fechas con un máximo de días por consulta, hoy 31). El botón Actualizar vuelve a consultar. Los horarios son hora de Argentina, y las métricas pueden tener hasta 5 minutos de demora: arriba a la izquierda se indica la hora de los datos.

Qué muestra el panel

Indicadores

• Requests: total de llamadas del período, con la cantidad de 2xx (exitosas)
• Tasa de error: porcentaje de llamadas con error, con el detalle de 4xx (error del cliente, por ejemplo datos inválidos) y 5xx (error del servidor)
• Errores 5xx: cantidad y porcentaje del total. Son los que dependen de Peakly y conviene reportar
• Cortadas (499): llamadas que tu sistema cortó antes de recibir la respuesta. Se desglosan según si el procesamiento terminó OK o con Error después del corte
• Latencia: p50, p95 y p99 (el tiempo en que respondió el 50, 95 y 99% de las llamadas), más el promedio y el máximo. Si ves "≈ aproximado", los percentiles se combinaron a partir de varias horas

Gráficos y rutas

• Requests por hora (o por día), por código de estado: barras apiladas con 2xx, 4xx, 5xx y 499. Con rangos de hasta 2 días agrupa por hora; con rangos mayores, por día
• Latencia por hora (o por día) (p50 / p95 / p99): evolución de los tiempos de respuesta
• Rutas con más volumen: tabla con Ruta, Requests, Error % y p95
• Rutas más lentas (p95, mín. 20 requests): tabla con Ruta, p50, p95, p99 y Requests

En las dos tablas, el ícono de la derecha de cada ruta (Ver requests de esta ruta) te baja al explorador con esa ruta ya filtrada. Si en el período no hubo llamadas ves "Sin requests en el rango".

Explorador de requests

Debajo del panel, el Explorador de requests lista las llamadas una por una (columnas Fecha, Request, Estado, Duración y Refs, con botón para copiar cada referencia). Filtros disponibles:

• Estado: Todos, 2xx (éxito), 4xx (error del cliente), 5xx (error del servidor), 499 (cortadas por el cliente) o Todos los errores
• Ruta: Todas las rutas o una de las rutas del panel
• Duración mínima (ms): para encontrar las llamadas lentas
• Idempotency-Key: valor exacto de la clave de idempotencia que mandó tu sistema
• Nº de orden / providerId: el identificador de tu pedido (por ejemplo ORD-12345), que también encuentra su nota de crédito asociada
• Limpiar filtros deja todo como estaba

Hacé clic en una fila para abrir el Detalle del request: fecha, duración, ruta, ID de request, Idempotency-Key, providerId, la API key usada (o "Sesión de usuario"), IP y User-Agent; si la llamada fue cortada, cuándo y con qué terminó; el mensaje de Error si lo hubo; y el Request body y Response body tal como se recibieron y respondieron (con las credenciales ocultas, y omitidos si superan los 64 KB).

Cómo diagnosticar una factura que falló

1. Entrá a Desarrolladores > Uso de la API y, en el explorador, filtrá por Estado 4xx o 5xx, o buscá el Nº de orden / providerId del pedido
2. Abrí el request y leí el Error y el Response body: ahí figura el motivo que devolvió la API
3. Si fue un 4xx, corregí los datos que envía tu sistema (ver Errores comunes en API Keys). Si fue un 5xx, reintentá y, si persiste, escribinos con el ID de request