APISalud pública del servicio
GET /v1/health
Estado general del servicio, sin llave y sin gastar cuota. Sale de una medición en segundo plano: si tiene más de 15 s responde degraded, aunque dijera ok. Con down el código es 503.
| Dato | Valor |
|---|---|
| Método y ruta | GET /v1/health |
| Servidor | https://widget.fital.xyz |
operationId | getHealth |
| Acceso | Público, sin llave |
| Firma de petición | No aplica |
| Idempotencia | No aplica |
- Esta operación no usa la forma de Errores: con
downresponde503con el mismo cuerpo que un200. Decide porstatus.
Encabezados de la petición
| Encabezado | Obligatorio | Descripción |
|---|
Sin llave ni otros encabezados obligatorios.
Respuestas correctas
200 Correcto
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
api_version | texto | Sí | Versión de la API. v1: la única publicada. |
status | texto | Sí | Estado general del servicio. ok: El servicio funciona. degraded: La medición es vieja o hay problemas parciales. Responde 200. down: El servicio no funciona. Responde 503. |
Valores de api_version
| Valor | Significado |
|---|---|
v1 | Versión de la API. |
Valores de status
| Valor | Significado |
|---|---|
ok | El servicio funciona. |
degraded | La medición tiene más de 15 segundos, o hay problemas parciales. Responde 200. |
down | El servicio no funciona. Responde 503. |
{
"status": "ok",
"api_version": "v1"
}Medición vieja o problema parcial: sigue en 200:
{
"status": "degraded",
"api_version": "v1"
}503 Servicio no disponible
Misma forma que la respuesta anterior.
{
"status": "down",
"api_version": "v1"
}Encabezados de la respuesta
| Encabezado | Contenido |
|---|---|
X-Request-Id | Identificador de la petición. Cítalo con soporte. |
Reintentos
Con 503, repite con espera exponencial.
Ver Reintentos y Límites.
Muestras
Variables de estas muestras: simulador público, sin cuenta
Define esto en tu terminal. Con estos valores las muestras corren tal cual contra el simulador público:
export FITAL_API="https://widget.fital.xyz/explorar/v1"
export FITAL_KEY="sk_test_sandbox_publica"En la cuenta de prueba o en producción cambia la base, la llave y el secreto, y sustituye los id de ejemplo por los tuyos. Ver Ambientes.
curl -sS "$FITAL_API/health"