API REST

Eventos y transacciones mediante la API REST

La API REST de DockRay permite enviar directamente errores, excepciones e información sobre transacciones HTTP a la plataforma DockRay desde cualquier aplicación, servicio o dispositivo.

Esta solución está diseñada principalmente para tecnologías para las que todavía no existe una biblioteca, módulo o plugin específico de DockRay.

Reporte de errores y excepciones

El endpoint de errores permite enviar eventos que contienen la información necesaria para diagnosticar problemas en la aplicación.

El evento reportado puede incluir, entre otros datos:

el tipo y el contenido del error o la excepción,
el stack trace,
el entorno y la versión de la aplicación,
información sobre el SDK, el runtime y el sistema operativo,
el contexto de la solicitud HTTP,
datos opcionales del usuario.

Monitorización de transacciones HTTP

Un endpoint independiente permite reportar transacciones HTTP procesadas, incluyendo el nombre de la transacción, el método, la dirección, la hora del evento, el código de respuesta y la información sobre el entorno.

Estos datos pueden utilizarse para analizar el tráfico, el historial de solicitudes y la distribución de las respuestas HTTP en el proyecto monitorizado.

Cualquier tecnología

La API REST no requiere ningún lenguaje de programación ni framework específico. Solo es necesario poder realizar solicitudes HTTP y enviar datos en formato JSON.

De este modo, DockRay puede integrarse con backends propios, microservicios, dispositivos, scripts y tecnologías menos populares.

Autenticación

Cada evento reportado se asigna a un proyecto mediante su token, y la solicitud se autentica mediante la clave privada del proyecto enviada en el encabezado Authorization.

La clave privada debe almacenarse exclusivamente en el servidor y no debe incluirse en el código público de la aplicación.

Formato de los datos

Los endpoints aceptan datos JSON en un formato compatible con el modelo de eventos de DockRay. El payload puede enviarse directamente o comprimirse mediante gzip.

Instalación

Para la integración necesitas el token del proyecto y la clave privada disponibles en el panel de DockRay.

El token del proyecto forma parte de la dirección del endpoint, mientras que la clave privada debe enviarse como Bearer Token en el encabezado Authorization.

Reporte de errores

Envía una solicitud POST al endpoint:

https://dockray.io/api/v1/PROJECT_TOKEN/project

Añade los encabezados requeridos:

Authorization: Bearer PROJECT_PRIVATE_KEY
Content-Type: application/json

Reporte de transacciones HTTP

Las transacciones se envían a un endpoint independiente:

https://dockray.io/api/v1/PROJECT_TOKEN/transaction

Cada transacción puede incluir, entre otros datos, el nombre de la ruta, el método HTTP, el código de respuesta, la hora del evento, el entorno e información sobre el runtime y la aplicación.

La clave privada del proyecto no debe incluirse en código que se ejecute en el navegador ni en otros lugares accesibles públicamente.

Instalacja - REST API Wymagania, instalacja i przygotowanie REST API do bezpiecznego raportowania danych produkcyjnych. Konfiguracja - REST API Bezpieczna konfiguracja poświadczeń, środowisk i zakresu danych raportowanych przez REST API. Weryfikacja i typowe problemy - REST API Kontrolowane potwierdzenie działania REST API oraz diagnostyka najczęstszych problemów z wysyłką.