Pular para o conteúdo principal

Ferramentas — API

Veja o guia conceitual em Ferramentas.

Registrar

POST /api/v1/tools admin

Requisição

{
"name": "consultar_fatura",
"description": "Consulta os detalhes de uma fatura pelo ID. Retorna valor, status e vencimento.",
"endpoint_url": "https://api.financeiro.exemplo.com/faturas/{id}",
"http_method": "GET",
"auth_type": "api_key",
"auth_config": { "header": "X-API-Key", "value": "sua-chave" },
"input_schema": {
"type": "object",
"properties": { "id": { "type": "string", "description": "ID da fatura" } },
"required": ["id"]
}
}

auth_type: none · api_key · bearer · oauth2_client_credentials · spiffe (identidade de workload).

Resposta 201 — a ferramenta criada.

Listar e obter

EndpointPapelDescrição
GET /api/v1/toolsleitorLista as ferramentas ativas.
GET /api/v1/tools/{tool_id}leitorDetalha uma ferramenta.

Atualizar e desativar

EndpointPapelDescrição
PUT /api/v1/tools/{tool_id}adminAtualização parcial.
DELETE /api/v1/tools/{tool_id}adminDesativa (soft delete): concessões são preservadas, mas a execução é bloqueada. Resposta 204.

Importar

POST /api/v1/tools/import/postman admin

POST /api/v1/tools/import/openapi admin

Importa ferramentas de uma Collection Postman v2.1 ou de uma spec OpenAPI 3.x.

Parâmetros de query: ?dry_run=true (apenas pré-visualiza) · ?overwrite=true (sobrescreve existentes).

Resposta 200

{
"imported": [{ "name": "consultar_fatura", "id": 5 }],
"skipped": [{ "name": "criar_fatura", "reason": "já existe" }],
"errors": [{ "name": "excluir_registro", "reason": "descrição ausente" }]
}