Présentation de la plateforme ouverte API
Pour les développeurs : Qu'est-ce qu'une plateforme ouverte, 5 minutes pour démarrer, portée ouverte, engagement de version.
La plate-forme ouverte Braidrun Workflow permet aux systèmes externes de piloter le flux de travail via une API REST stable : déclencher l'exécution, lire les résultats, pousser les décisions d'approbation et télécharger les produits. Toutes les interfaces publiques sont authentifiées par clé API - le même mécanisme couvre les webhooks, les rappels d'approbation et les points de terminaison de la plateforme ouverte v1.
Qui devrait utiliser
- Développeurs qui ont besoin de déclencher des flux de travail dans CI/CD, les systèmes d'entreprise internes et les services d'applications mobiles
- Scénario opérationnel consistant à finaliser l'approbation en cliquant sur un lien depuis Slack/Telegram/e-mail
- Une équipe qui fournit du Workflow-as-a-Service aux partenaires
- Équipes de données qui doivent renvoyer les résultats d'exécution vers l'entrepôt de données/le système BI de l'entreprise
Architecture globale
┌──────────────────┐ Authorization: Bearer dyk_xxx ┌──────────────────────┐
│ 你的客户端 │ ───────────────────────────────────▶ │ Braidrun Workflow │
│ │ │ 开放平台 v1 / Webhook │
│ - SDK / curl │ ◀─── 200 OK + JSON ──────────────── │ │
│ - CI/CD │ ◀─── 429 + Retry-After ──────────── │ - 校验 scope │
│ - 邮件链接 │ ◀─── 401 Unauthorized ───────────── │ - 速率限制 │
└──────────────────┘ │ - 累计用量 │
└──────────────────────┘Un appel de plateforme ouverte complet : le client détient un Token sous la forme dyk_<id>_<secret>, et porte un Bearer Header à chaque requête ; le serveur accumule automatiquement l'utilisation après avoir vérifié la portée ; lorsque la limite supérieure du tarif du forfait est dépassée, HTTP 429 + Retry-After est renvoyé.
Commencez en 5 minutes
- Connexion Console Braidrun → Entrez "Paramètres du compte → Clé API"
- Créer une clé API Cliquez sur "Nouvelle clé API" → sélectionnez la portée requise (il est recommandé de sélectionner d'abord WORKFLOW_READ + WORKFLOW_EXECUTE) → définissez la période de validité
- Copier le jeton Après une génération réussie, un affichage unique du jeton apparaîtra. Copiez-le et enregistrez-le immédiatement dans votre outil de gestion de clés.
- Appeler un test de point de terminaison Utilisez curl pour extraire votre propre liste de flux de travail :
curl https://braidrun.com/api/v1/workflows \
-H "Authorization: Bearer dyk_<id>_<secret>"Gamme ouverte
| domaine | gamme |
|---|---|
| Déclencheur Webhook | Système externe → POST déclenche l'exécution du flux de travail lié |
| Webhook d’approbation | Approbation/rejet en un clic à partir des étapes d'approbation manuelle de Mail/Slack/Telegram |
| flux de travail v1 | Répertorier/lire les définitions de flux de travail ; lancer l'exécution via l'API |
| Exécuter la v1 | Statut d'exécution de la requête/lecture des résultats/annulation de l'exécution |
| Approbation v1 | Lister les approbations en attente / lire les détails d'une approbation / approuver (avec possibilité de joindre les données du formulaire d'approbation modifié) / rejeter les étapes manual_approval |
| Produit v1 | Répertorier les produits d'exécution/obtenir les liens de téléchargement des produits |
Consulter le guide
- SDK officiels · Clients API fortement typés pour 12 langages
- Gestion des clés API · Créer/Portée/Révocation/Analyse d'utilisation
- Authentification et limitation de débit · Trois façons d'écrire l'en-tête/le tarif du package/le code d'erreur
- Point de terminaison du webhook · Déclencheur de workflow + rappel d'approbation
- Référence du point de terminaison v1 · L'ensemble des 14 endpoints v1
La v1 est une surface API stable : les champs ne seront pas supprimés de manière destructive et de nouveaux champs peuvent être ajoutés. Les modifications majeures seront publiées avec un nouveau préfixe de chemin v2 et fourniront une période de coexistence v1 → v2 minimale de 6 mois.