> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Estado programático

> Consultar el estado del servicio en tiempo real para todos los servicios de Truthlocks. No se requiere autenticación.

Devuelve el estado de salud actual de cada servicio de Truthlocks. Utilice este endpoint para integrar la disponibilidad del servicio en sus propios paneles, tuberías de alerta o disyuntores.

Este punto final se sirve desde `status.truthlocks.com`, no desde la API principal. No se requiere autenticación.

```http theme={null}
GET https://status.truthlocks.com/api/health
```

### Campos de respuesta

| Campo | Tipo | Descripción |
| - | - | - |
| `status` | string | Estado general del sistema: `operational`, `degraded`, o `outage`. |
| `timestamp` | string | Marca de tiempo ISO 8601 de la verificación. |
| `services` | array | Resultados de salud por servicio. |
| `services[].id` | string | Identificador de servicio legible por máquina (por ejemplo, `api-gateway`, `signing-service`). |
| `services[].name` | string | Nombre del servicio legible. |
| `services[].status` | string | Estado del servicio: `operational`, `degraded`, o `outage`. |
| `services[].responseTime` | number or null | Tiempo de respuesta en milisegundos, o `null` si es inalcanzable. |
| `services[].error` | string | Presente solo cuando el servicio no está operativo. Describe el motivo del fallo. |

### Lógica de estado

* **`operational`** — todos los servicios están en buen estado y responden normalmente.
* **`degraded`** — al menos un servicio es lento o devuelve errores, pero ninguno está completamente inactivo.
* **`outage`** — al menos un servicio es completamente inaccesible.

### Servicios monitoreados

| ID de servicio | Nombre | Descripción |
| - | - | - |
| `api-gateway` | API Gateway | Punto final principal de la API para todas las solicitudes públicas |
| `trust-registry` | Registro de Confianza | Gestión y gobernanza de emisores |
| `billing-service` | Facturación | Procesamiento de suscripciones y pagos |
| `signing-service` | Firma | Operaciones de firma criptográfica |
| `attestation-service` | Atestaciones | Creación y gestión de atestaciones |
| `audit-service` | Registros de auditoría | Registro de actividad y cumplimiento |
| `transparency-log` | Registro de Transparencia | Registro criptográfico de solo anexar |
| `verification-service` | Verificación | Verificación de paquete de prueba |

### Ejemplo: estado de sondeo desde su aplicación

```javascript theme={null}
async function checkTruthlockStatus() {
  const res = await fetch("https://status.truthlocks.com/api/health");
  const data = await res.json();

  if (data.status !== "operational") {
    console.warn(`Truthlocks is ${data.status}`);
    const issues = data.services.filter((s) => s.status !== "operational");
    issues.forEach((s) =>
      console.warn(`  ${s.name}: ${s.status} — ${s.error}`)
    );
  }

  return data;
}
```

### Ejemplo: verificación previa al acuñado

```javascript theme={null}
async function mintWithStatusCheck(attestation) {
  const status = await fetch("https://status.truthlocks.com/api/health");
  const health = await status.json();

  const signingService = health.services.find(
    (s) => s.id === "signing-service"
  );
  const attestationService = health.services.find(
    (s) => s.id === "attestation-service"
  );

  if (
    signingService?.status !== "operational" ||
    attestationService?.status !== "operational"
  ) {
    throw new Error("Required services are not operational — retry later");
  }

  return client.attestations.mint(attestation);
}
```

> [!NOTE]
>
> Este punto de conexión tiene un límite de velocidad para evitar abusos. Para una supervisión continua, sondee
> no más frecuentemente que una vez cada 30 segundos.


## OpenAPI

````yaml es/mint-openapi.yaml GET /api/health
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks es una infraestructura de verificación universal para documentos,
    credenciales y activos digitales.

    Esta especificación define la API canónica para interactuar con los
    servicios de Truthlocks.


    ## URLs Base

    - **Producción**: `https://api.truthlocks.com`

    - **Sandbox**: `https://sandbox-api.truthlocks.com`


    ## Autenticación

    - **Claves API**: Use el encabezado `X-API-Key` para operaciones máquina a
    máquina

    - **Tokens Bearer**: Use `Authorization: Bearer <jwt>` para operaciones
    iniciadas por el usuario


    ## Identidad del Inquilino

    En producción, la identidad del inquilino se deriva del contexto autenticado
    (clave API o JWT).

    El encabezado `X-Tenant-ID` se ignora en producción para evitar la
    suplantación de identidad.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: API de producción
  - url: https://sandbox-api.truthlocks.com
    description: Entorno Sandbox
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: Gestión de claves y tokens de API
  - name: Issuers
    description: Registro del emisor y gestión de la confianza
  - name: Keys
    description: Gestión de claves criptográficas para emisores
  - name: Attestations
    description: Ciclo de vida de la atestación (acuñar, revocar, reemplazar)
  - name: Verification
    description: Verificación de atestación y paquetes de prueba
  - name: Governance
    description: Flujos de trabajo de gobernanza del emisor (solo administrador)
  - name: Identity
    description: Gestión de organización, usuarios y roles
  - name: Audit
    description: Consultas de eventos de auditoría
  - name: Tenant Console
    description: Puntos finales de perfil y ciclo de vida del inquilino
  - name: Health
    description: Endpoints de estado y preparación del servicio
  - name: Risk
    description: Ingesta de señales de riesgo y detección de fraude
  - name: Risk Enforcement
    description: >-
      Acciones de aplicación de riesgos: bloqueo, desafío, cuarentena y
      configuración
  - name: Billing
    description: Gestión de facturación, suscripciones y complementos
  - name: Machine Identity
    description: >-
      Protocolo de Identidad de Agente de Máquina (MAIP) — registro de agentes,
      sesiones, confianza, testigo, cumplimiento, orquestación y observabilidad
externalDocs:
  description: API de transparencia de solo lectura (especificación de servicio separada)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /api/health:
    get:
      tags:
        - Health
      summary: Estado programático
      description: >-
        Devuelve el estado del servicio en tiempo real para todos los servicios
        de Truthlocks. No se requiere autenticación.
      operationId: health.status
      responses:
        '200':
          description: Estado del servicio
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                      - operational
                      - degraded
                      - outage
                  timestamp:
                    type: string
                    format: date-time
                  services:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        name:
                          type: string
                        status:
                          type: string
                        responseTime:
                          nullable: true
                          type: integer
                        lastChecked:
                          type: string
                          format: date-time
                        error:
                          type: string
                          description: >-
                            Presente cuando una verificación de estado informe
                            un fallo.
      security: []
      servers:
        - url: https://status.truthlocks.com
components:
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Clave API para autenticación máquina a máquina
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT para operaciones iniciadas por el usuario

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.