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

# Status programático

> Consulte a saúde do serviço em tempo real para todos os serviços Truthlocks. Nenhuma autenticação é necessária.

Retorna o status de saúde atual de cada serviço Truthlocks. Use este endpoint para integrar a disponibilidade do serviço em seus próprios painéis, pipelines de alerta ou disjuntores.

Este endpoint é servido de `status.truthlocks.com`, não da API principal. Nenhuma autenticação é necessária.

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

### Campos de resposta

| Campo | Tipo | Descrição |
| - | - | - |
| `status` | string | Saúde geral do sistema: `operational`, `degraded`, ou `outage`. |
| `timestamp` | string | Carimbo de data/hora ISO 8601 da verificação. |
| `services` | array | Resultados de saúde por serviço. |
| `services[].id` | string | Identificador de serviço legível por máquina (por exemplo, `api-gateway`, `signing-service`). |
| `services[].name` | string | Nome do serviço legível. |
| `services[].status` | string | Saúde do serviço: `operational`, `degraded`, ou `outage`. |
| `services[].responseTime` | number or null | Tempo de resposta em milissegundos, ou `null` se inacessível. |
| `services[].error` | string | Presente apenas quando o serviço não está operacional. Descreve o motivo da falha. |

### Lógica de status

* **`operational`** — todos os serviços estão saudáveis e respondendo normalmente.
* **`degraded`** — pelo menos um serviço está lento ou retornando erros, mas nenhum está completamente inoperante.
* **`outage`** — pelo menos um serviço está completamente inacessível.

### Serviços monitorizados

| ID do Serviço | Nome | Descrição |
| - | - | - |
| `api-gateway` | API Gateway | Ponto de extremidade principal da API para todas as solicitações públicas |
| `trust-registry` | Registro de Confiança | Gerenciamento e governança do emissor |
| `billing-service` | Faturação | Processamento de subscrições e pagamentos |
| `signing-service` | Assinatura | Operações criptográficas de assinatura |
| `attestation-service` | Atestados | Criação e gestão de atestados |
| `audit-service` | Registos de Auditoria | Registo de atividades e conformidade |
| `transparency-log` | Log de Transparência | Log criptográfico somente de adição |
| `verification-service` | Verificação | Verificação de pacote de prova |

### Exemplo: consultar status do seu aplicativo

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

### Exemplo: verificação pré-cunhagem

```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 endpoint é limitado por taxa para evitar abusos. Para monitoramento contínuo, consulte
> não mais frequentemente do que uma vez a cada 30 segundos.


## OpenAPI

````yaml pt/mint-openapi.yaml GET /api/health
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >-
    Truthlocks é uma infraestrutura de verificação universal para documentos,
    credenciais e ativos digitais.

    Esta especificação define a API canônica para interagir com os serviços
    Truthlocks.


    ## URLs Base

    - **Produção**: `https://api.truthlocks.com`

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


    ## Autenticação

    - **Chaves de API**: Use o cabeçalho `X-API-Key` para operações máquina a
    máquina

    - **Tokens de Portador**: Use `Authorization: Bearer <jwt>` para operações
    iniciadas pelo usuário


    ## Identidade do Inquilino

    Em produção, a identidade do inquilino é derivada do contexto autenticado
    (chave de API ou JWT).

    O cabeçalho `X-Tenant-ID` é ignorado em produção para evitar falsificação.
  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 Produção
  - url: https://sandbox-api.truthlocks.com
    description: Ambiente Sandbox
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: Gerenciamento de chaves e tokens de API
  - name: Issuers
    description: Registro do emissor e gerenciamento de confiança
  - name: Keys
    description: Gerenciamento de chaves criptográficas para emissores
  - name: Attestations
    description: Ciclo de vida da atestação (cunhar, revogar, substituir)
  - name: Verification
    description: Verificação de atestado e pacotes de prova
  - name: Governance
    description: Fluxos de trabalho de governança do emissor (somente administrador)
  - name: Identity
    description: Gerenciamento de organização, usuário e função
  - name: Audit
    description: Consultas de eventos de auditoria
  - name: Tenant Console
    description: Endpoints de perfil e ciclo de vida do locatário
  - name: Health
    description: Endpoints de saúde e prontidão do serviço
  - name: Risk
    description: Ingestão de sinal de risco e detecção de fraude
  - name: Risk Enforcement
    description: Ações de aplicação de risco — bloqueio, desafio, quarentena e configuração
  - name: Billing
    description: Gerenciamento de faturamento, assinatura e complementos
  - name: Machine Identity
    description: >-
      Protocolo de Identidade de Agente de Máquina (MAIP) — registro de agente,
      sessões, confiança, testemunha, conformidade, orquestração e
      observabilidade
externalDocs:
  description: API somente leitura de transparência (especificação de serviço separada)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /api/health:
    get:
      tags:
        - Health
      summary: Status programático
      description: >-
        Retorna a saúde do serviço em tempo real para todos os serviços
        Truthlocks. Nenhuma autenticação é necessária.
      operationId: health.status
      responses:
        '200':
          description: Saúde do serviço
          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 quando uma verificação de saúde relata uma
                            falha.
      security: []
      servers:
        - url: https://status.truthlocks.com
components:
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave de API para autenticação máquina a máquina
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT para operações iniciadas pelo usuário

````

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