API abrir Visão Geral da Plataforma

A plataforma aberta Braidrun Workflow permite que sistemas externos ativem o workflow através de uma API REST estável: acionar execução, ler resultados, empurrar decisões de aprovação e baixar produtos. Todas as interfaces públicas são autenticadas pela API Key - o mesmo mecanismo cobre webhooks, callbacks de aprovação e terminais abertos da plataforma v1.

Quem deve utilizar

• Desenvolvedores que precisam ativar workflows em CI/CD, sistemas de negócios internos e serviços de aplicativos móveis
• Cenário de operação de completar a aprovação clicando em um link do Slack/Telegram/email
• Uma equipe que fornece Workflow-as-a-Service aos parceiros
• Equipes de dados que precisam fluir resultados de execução de volta para o sistema corporativo data warehouse/BI

Arquitetura geral

┌──────────────────┐    Authorization: Bearer dyk_xxx     ┌──────────────────────┐
│   你的客户端     │ ───────────────────────────────────▶ │  Braidrun Workflow    │
│                  │                                       │   开放平台 v1 / Webhook │
│  - SDK / curl    │ ◀─── 200 OK + JSON ──────────────── │                      │
│  - CI/CD         │ ◀─── 429 + Retry-After ──────────── │  - 校验 scope        │
│  - 邮件链接      │ ◀─── 401 Unauthorized ───────────── │  - 速率限制          │
└──────────────────┘                                       │  - 累计用量          │
                                                            └──────────────────────┘

Uma chamada de plataforma aberta completa: o cliente mantém um Token na forma de dyk <id> <secret>, e carrega um Bearer Header com cada solicitação; o servidor automaticamente acumula o uso após verificar o escopo; quando o limite superior da taxa do pacote é excedido, HTTP 429 + Retry-After é retornado.

Comece em 5 minutos

1. Login Consola Braidrun → Digite "Configurações de Conta → Chave API"
2. Criar chave de API Clique em "New API Key" → selecione o escopo necessário (é recomendado selecionar WORKFLOW READ + WORKFLOW EXECUTE primeiro) → definir o período de validade
3. Copiar item Após a geração de sucesso, uma exibição única do Token aparecerá. Copie e salve-o para sua ferramenta de gerenciamento de chaves imediatamente.
4. Convocar um teste final Use curl para puxar sua própria lista de workflow:

curl https://braidrun.com/api/v1/workflows \
  -H "Authorization: Bearer dyk_<id>_<secret>"

Abrir o intervalo

Consulte o guia

• SDK oficial · Clientes de API com tipagem segura para 12 linguagens
• Gerenciamento de chaves da API · Criar / Escopo / Revogação / Análise de Uso
• Autenticação e limitação de taxas · Três maneiras de escrever Header/package rate/error code
• Endpoint Webhook · Ativador de workflow + chamada de aprovação
• Referência do ponto de avaliação v1 · Todos os objetivos de 14 v1