> ## 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.

# Statut programmatique

> Interroger l'état du service en temps réel pour tous les services Truthlocks. Aucune authentification requise.

Renvoie l'état de santé actuel de chaque service Truthlocks. Utilisez ce point de terminaison pour intégrer la disponibilité des services dans vos propres tableaux de bord, pipelines d'alerte ou disjoncteurs.

Ce point de terminaison est servi depuis `status.truthlocks.com`, et non l'API principale. Aucune authentification n'est requise.

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

### Champs de réponse

| Champ | Type | Description |
| - | - | - |
| `status` | chaîne | État général du système : `operational`, `degraded`, ou `outage`. |
| `timestamp` | string | Horodatage ISO 8601 de la vérification. |
| `services` | array | Résultats de santé par service. |
| `services[].id` | chaîne | Identifiant de service lisible par machine (par exemple, `api-gateway`, `signing-service`). |
| `services[].name` | string | Nom de service lisible par l'homme. |
| `services[].status` | chaîne | État du service : `operational`, `degraded`, ou `outage`. |
| `services[].responseTime` | number or null | Temps de réponse en millisecondes, ou `null` si inaccessible. |
| `services[].error` | chaîne | Présent uniquement lorsque le service n'est pas opérationnel. Décrit la raison de l'échec. |

### Logique d'état

* **`operational`** — tous les services sont sains et répondent normalement.
* **`degraded`** — au moins un service est lent ou renvoie des erreurs, mais aucun n'est complètement en panne.
* **`outage`** — au moins un service est complètement inaccessible.

### Services surveillés

| ID de service | Nom | Description |
| - | - | - |
| `api-gateway` | API Gateway | Point de terminaison API principal pour toutes les requêtes publiques |
| `trust-registry` | Registre de Confiance | Gestion et gouvernance des émetteurs |
| `billing-service` | Facturation | Traitement des abonnements et des paiements |
| `signing-service` | Signature | Opérations de signature cryptographique |
| `attestation-service` | Attestations | Création et gestion d'attestations |
| `audit-service` | Journaux d'audit | Journalisation d'activité et conformité |
| `transparency-log` | Journal de Transparence | Journal cryptographique en ajout seulement |
| `verification-service` | Vérification | Vérification du paquet de preuves |

### Exemple : interroger le statut depuis votre application

```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;
}
```

### Exemple : vérification préalable à la frappe

```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]
>
> Ce point de terminaison est soumis à des limites de débit pour éviter les abus. Pour une surveillance continue, interrogez
> pas plus fréquemment qu'une fois toutes les 30 secondes.


## OpenAPI

````yaml fr/mint-openapi.yaml GET /api/health
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >
    Truthlocks est une infrastructure de vérification universelle pour les
    documents, les identifiants et les actifs numériques.

    Cette spécification définit l'API canonique pour interagir avec les services
    Truthlocks.


    ## URL de base

    - **Production** : `https://api.truthlocks.com`

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


    ## Authentification

    - **Clés API** : Utilisez l'en-tête `X-API-Key` pour les opérations de
    machine à machine

    - **Jetons Bearer** : Utilisez `Authorization: Bearer <jwt>` pour les
    opérations initiées par l'utilisateur


    ## Identité du locataire

    En production, l'identité du locataire est dérivée du contexte authentifié
    (clé API ou JWT).

    L'en-tête `X-Tenant-ID` est ignoré en production pour éviter l'usurpation
    d'identité.
  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 production
  - url: https://sandbox-api.truthlocks.com
    description: Environnement de bac à sable
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: Gestion des clés API et des jetons
  - name: Issuers
    description: Enregistrement de l'émetteur et gestion de la confiance
  - name: Keys
    description: Gestion des clés cryptographiques pour les émetteurs
  - name: Attestations
    description: Cycle de vie de l'attestation (créer, révoquer, remplacer)
  - name: Verification
    description: Vérification des attestations et lots de preuves
  - name: Governance
    description: Flux de travail de gouvernance de l'émetteur (administrateur uniquement)
  - name: Identity
    description: Gestion de l'organisation, des utilisateurs et des rôles
  - name: Audit
    description: Requêtes d'événements d'audit
  - name: Tenant Console
    description: Points de terminaison du profil et du cycle de vie du locataire
  - name: Health
    description: Points de terminaison de l'état et de la disponibilité du service
  - name: Risk
    description: Ingestion de signaux de risque et détection de fraude
  - name: Risk Enforcement
    description: >-
      Actions d'application des risques — blocage, défi, quarantaine et
      configuration
  - name: Billing
    description: Gestion de la facturation, des abonnements et des modules complémentaires
  - name: Machine Identity
    description: >-
      Protocole d'identité d'agent machine (MAIP) — enregistrement d'agent,
      sessions, confiance, témoin, conformité, orchestration et observabilité
externalDocs:
  description: API de transparence en lecture seule (spécification de service séparée)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /api/health:
    get:
      tags:
        - Health
      summary: Statut programmatique
      description: >-
        Retourne l'état de santé du service en temps réel pour tous les services
        Truthlocks. Aucune authentification requise.
      operationId: health.status
      responses:
        '200':
          description: État du service
          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: >-
                            Présent lorsqu'un contrôle de santé signale une
                            défaillance.
      security: []
      servers:
        - url: https://status.truthlocks.com
components:
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Clé API pour l'authentification machine-à-machine
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT pour les opérations initiées par l'utilisateur

````

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