🔌 Integrações

GET /api/v1/integrations

Lista todas as integrações.

Query Parameters

  • page (opcional): Número da página
  • page_size (opcional): Itens por página
  • status (opcional): Filtrar por status (active, inactive)

Response: 200 OK

{
  "data": [
    {
      "id": "uuid",
      "org_id": "uuid",
      "app_code": "minha-api",
      "display_name": "Minha API",
      "status": "active",
      "created_at": "2024-01-01T00:00:00Z"
    }
  ],
  "page": 1,
  "page_size": 25,
  "total": 10
}

Nota: O campo secret não é retornado por questões de segurança.

POST /api/v1/integrations

Cria uma nova integração.

Request

{
  "org_id": "uuid",
  "app_code": "minha-api",
  "display_name": "Minha API",
  "status": "active"
}

Response: 201 Created

{
  "id": "uuid",
  "org_id": "uuid",
  "app_code": "minha-api",
  "display_name": "Minha API",
  "secret": "abc123...", // ⚠️ Retornado apenas na criação
  "status": "active",
  "created_at": "2024-01-01T00:00:00Z"
}

Nota: O secret é gerado automaticamente se não fornecido e só é retornado nesta resposta.

GET /api/v1/integrations/[id]

Obtém uma integração específica.

Response: 200 OK

PATCH /api/v1/integrations/[id]

Atualiza uma integração.

Request

{
  "status": "inactive",
  "display_name": "Novo Nome"
}

Response: 200 OK