Descripción general de la plataforma abierta API

La plataforma abierta Braidrun Workflow permite que los sistemas externos impulsen el flujo de trabajo a través de una API REST estable: active la ejecución, lea resultados, impulse decisiones de aprobación y descargue productos. Todas las interfaces públicas están autenticadas mediante clave API; el mismo mecanismo cubre webhooks, devoluciones de llamada de aprobación y puntos finales de plataforma abierta v1.

¿Quién debería usar?

• Desarrolladores que necesitan activar flujos de trabajo en CI/CD, sistemas empresariales internos y servicios de aplicaciones móviles
• Escenario operativo para completar la aprobación haciendo clic en un enlace de Slack/Telegram/correo electrónico
• Un equipo que proporciona flujo de trabajo como servicio a los socios
• Equipos de datos que necesitan transmitir los resultados de la ejecución al sistema de BI o almacén de datos empresarial.

Arquitectura general

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

Una llamada de plataforma abierta completa: el cliente posee un token en forma de dyk_<id>_<secret> y lleva un encabezado de portador con cada solicitud; el servidor acumula automáticamente el uso después de verificar el alcance; cuando se excede el límite superior de la tasa del paquete, se devuelve HTTP 429 + Retry-After.

Empiece en 5 minutos

1. Iniciar sesión Consola Braidrun → Ingrese "Configuración de cuenta → Clave API"
2. Crear clave API Haga clic en "Nueva clave API" → seleccione el alcance requerido (se recomienda seleccionar WORKFLOW_READ + WORKFLOW_EXECUTE primero) → establezca el período de validez
3. Copiar token Después de una generación exitosa, aparecerá una visualización única del Token. Cópielo y guárdelo en su herramienta de administración de claves inmediatamente.
4. Llamar a una prueba de punto final Utilice curl para generar su propia lista de flujo de trabajo:

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

Rango abierto

Consulta la guía

• SDK oficiales · Clientes API con seguridad de tipos para 12 lenguajes
• Gestión de claves API · Crear / Alcance / Revocación / Análisis de uso
• Autenticación y limitación de velocidad · Tres formas de escribir encabezado/tasa de paquete/código de error
• Punto final del webhook · Activador de flujo de trabajo + devolución de llamada de aprobación
• Referencia del punto final v1 · Los 14 endpoints v1 completos