Referencia del API · tag system
Sistema
Salud del gateway e introspección de la llave: tenant y scopes.
Esta página se genera desde el contrato (data/gateway-v1.json): cada operación muestra su verbo,
ruta, parámetros, cuerpo, respuestas, si lleva Idempotency-Key y el método equivalente en los cinco SDK.
Para el flujo de punta a punta con ejemplos completos, ve a la guía de implementación.
Operaciones del tag system #
Descripción en el contrato: Gateway health and key/scope introspection.
| Método | Ruta | Operación | Scope | Idem. |
|---|---|---|---|---|
| GET | /v1/gateway/health/ | Health — validate the API key and return its scopes | — | — |
Health — validate the API key and return its scopes #
GET/v1/gateway/health/
Respuestas
| Código | Descripción | Cuerpo |
|---|---|---|
| 200 | Key valid. | GatewayHealth
application/json |
Errores posibles (400, 401, 403, 404, 409, 422, 429, 500) — application/problem+json
| 400 | Malformed request. | about:blank |
| 401 | Missing or invalid API key. | about:blank |
| 403 | The key is valid but lacks the required scope, or the source IP is not allow-listed. | about:blank |
| 404 | The requested resource does not exist. | about:blank |
| 409 | Idempotency conflict — same key, original still processing. | https://errors.compense.co/gateway/idempotency-conflict |
| 422 | Request body failed validation. | https://errors.compense.co/gateway/validation |
| 429 | Per-key rate limit or monthly quota exceeded; see Retry-After. | https://errors.compense.co/gateway/rate-limited |
| 500 | Unexpected gateway error; quote the trace_id to support. | about:blank |
Ver Errores problem+json para la excepción equivalente en cada SDK.
Ejemplo
client.system.health()client.system.health()$client->system->health()await client.System.HealthAsync()client.System.Health(ctx, …)curl "https://sandbox.dev.compense.co/gw/v1/gateway/health/" \
-H "X-API-Key: $COMPENSE_API_KEY"Los métodos de cada SDK salen de su suite de paridad con el contrato. El cURL va contra el sandbox; los valores <campo> son marcadores.