Braidrun SDK
Usa 13 clientes con seguridad de tipos para 12 lenguajes para llamar a las API de flujos de trabajo, ejecuciones, artefactos, aprobaciones y webhooks.
Braidrun SDK es la colección oficial de clientes con seguridad de tipos para la API de la plataforma abierta. Encapsula los endpoints de flujos de trabajo, ejecuciones, artefactos, aprobaciones humanas y webhooks en métodos y modelos de datos propios de cada lenguaje, para que no tengas que escribir a mano las solicitudes HTTP ni los tipos de respuesta.
Clientes compatibles
El repositorio ofrece 13 implementaciones de cliente para 12 lenguajes. Cada directorio contiene un cliente independiente con metadatos del paquete, modelos de API, pruebas y la documentación completa de endpoints para ese lenguaje.
Servidor y backend
Web y Node.js
Móvil y multiplataforma
Cobertura de la API
Todos los clientes cubren las mismas funciones públicas y adaptan automáticamente los nombres de los métodos a las convenciones de cada lenguaje.
| Área funcional | Qué puedes hacer |
|---|---|
| Flujos | Enumera y consulta flujos de trabajo e inicia una ejecución de forma asíncrona. |
| Ejecutar | Consulta el estado, el historial y el resultado final, o cancela una ejecución que siga activa. |
| Artefacto | Lee los archivos y los metadatos de artefactos generados por una ejecución. |
| Aprobación manual | Consulta las aprobaciones pendientes y envía una decisión de aprobación o rechazo. |
| Webhook | Registra y administra webhooks, consulta estadísticas y activa flujos de trabajo mediante webhooks. |
Inicio rápido
- Crea una clave en «Configuración de la cuenta → Claves API» y concede únicamente los ámbitos necesarios para tus llamadas.
- Elige el cliente que corresponda a tu stack tecnológico y abre el README de su directorio.
- Instala las dependencias desde el código fuente y configura la API Key mediante una variable de entorno.
- Crea un cliente API y consulta primero la lista de flujos de trabajo para comprobar la conexión y los permisos.
python -m pip install "git+https://github.com/Braidrun/braidrun-sdk.git#subdirectory=python"import os
import braidrun_sdk
configuration = braidrun_sdk.Configuration(
host="https://braidrun.com",
access_token=os.environ["BRAIDRUN_API_KEY"],
)
with braidrun_sdk.ApiClient(configuration) as client:
workflows = braidrun_sdk.WorkflowsApi(client)
result = workflows.list_workflows()
print(result)Actualmente, los SDK se distribuyen desde su repositorio de código en GitHub y su disponibilidad en los gestores de paquetes de cada lenguaje puede variar. Consulta el README del directorio correspondiente; no des por hecho que todos los clientes están publicados en repositorios de paquetes públicos.
Autenticación y permisos
Se recomienda leer la API Key que empieza por dyk_ desde una variable de entorno o un servicio de gestión de secretos y usar un encabezado Bearer. No escribas una clave real en el código fuente, los registros ni el frontend del navegador. Cada endpoint sigue comprobando el ámbito correspondiente; que el cliente tenga seguridad de tipos no concede permisos automáticamente.
Los SDK también generan las API de gestión de webhooks, pero los endpoints de administración bajo /api/webhooks usan una sesión del navegador o una cuenta de servicio de administrador y no aceptan las API Keys estándar con permisos granulares de la plataforma abierta. Los endpoints que activan webhooks sí pueden usar una clave de la plataforma abierta con el ámbito WEBHOOK_TRIGGER.
Cuando la API devuelva 429, respeta Retry-After y usa X-RateLimit-Limit y X-RateLimit-Window para ajustar el intervalo entre reintentos.
¿SDK o motor de flujos de trabajo?
| Proyecto | Adecuado para la escena | Se ejecuta en |
|---|---|---|
braidrun-sdk | Llama a la API de la plataforma en la nube de Braidrun desde tu aplicación con tipos y modelos propios de cada lenguaje. | Tu aplicación + plataforma en la nube de Braidrun |
braidrun-workflow | Ejecuta flujos de trabajo YAML en tu propio entorno o integra el entorno de ejecución en un proyecto Kotlin/JVM. | Entornos locales, de servidor o de CI administrados por ti |
Ver la presentación completa de ambos proyectos