Pular para o conteúdo

Endpoints

Referência dos caminhos, permissões e exemplo completo.

MétodoCaminhoPermissãoDescrição
POST/v1/auth/token—Troca client_id e client_secret por um access token (JWT).
GET/v1/mequalquerDados da chave: nome, permissões e ambientes liberados.
GET/v1/workspacesqualquerAmbientes em que a chave pode agir.
GET/v1/workspaces/{workspace_id}/workflowsworkflows:readLista os workflows do ambiente.
POST/v1/workspaces/{workspace_id}/workflows/{workflow_id}/runsworkflows:runDispara o workflow. Responde 202 com run_id e status_url.
GET/v1/workspaces/{workspace_id}/workflows/{workflow_id}/runs/{run_id}workflows:read ou :runStatus do run e de cada etapa.
GET/v1/workspaces/{workspace_id}/pipelinespipelines:readLista os pipelines do ambiente.
POST/v1/workspaces/{workspace_id}/pipelines/{pipeline_id}/runspipelines:runDispara o pipeline. Responde 202 com run_id e status_url.
GET/v1/workspaces/{workspace_id}/pipelines/{pipeline_id}/runs/{run_id}pipelines:read ou :runStatus e contagens (lidas, gravadas) da execução.

Exemplo

bash
# 1. Obter o token (válido por 1 hora; reaproveite até expirar)
TOKEN=$(curl -s -X POST "https://d4controller.com.br/api/v1/auth/token" \
  -H "Content-Type: application/json" \
  -d '{"grant_type": "client_credentials", "client_id": "'"$VDG_CLIENT_ID"'", "client_secret": "'"$VDG_CLIENT_SECRET"'"}' \
  | jq -r .access_token)

# 2. Disparar um workflow (idempotency_key evita execução duplicada em retentativas)
curl -s -X POST "https://d4controller.com.br/api/v1/workspaces/<workspace_id>/workflows/<workflow_id>/runs" \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d '{"idempotency_key": "carga-2026-10-06"}'

# 3. Acompanhar pelo status_url da resposta
curl -s "https://d4controller.com.br/api/v1/workspaces/<workspace_id>/workflows/<workflow_id>/runs/<run_id>" \
  -H "Authorization: Bearer $TOKEN"