Aller au contenu principal
DocumentPlateforme ouverte APISDK officiels
Plateforme ouverte · 12 langages

Braidrun SDK

Utilisez 13 clients fortement typés couvrant 12 langages pour appeler les API de workflows, d'exécutions, d'artefacts, d'approbations et de webhooks.

Braidrun SDK est la collection officielle de clients fortement typés pour l'API de la plateforme ouverte. Elle encapsule les endpoints de workflows, d'exécutions, d'artefacts, d'approbations humaines et de webhooks dans des méthodes et modèles de données familiers pour chaque langage, afin que vous n'ayez pas à écrire manuellement les requêtes HTTP et les types de réponse.

Dépôt source officielgithub.com/Braidrun/braidrun-sdkTous les clients sont générés à partir de la même spécification OpenAPI 3.0.3 et partagent des interfaces et modèles cohérents avec l'API 1.0.
Voir le dépôt

Clients pris en charge

Le dépôt fournit 13 implémentations clientes couvrant 12 langages. Chaque répertoire constitue un client autonome et contient les métadonnées du paquet, les modèles d'API, les tests et la documentation complète des endpoints pour ce langage.

Serveur et backend

C#GoJavaKotlinPHPPythonRubyRust

Web et Node.js

JavaScriptTypeScript · FetchTypeScript · Axios

Mobile et multiplateforme

DartSwift 5

Couverture de l'API

Tous les clients couvrent les mêmes fonctionnalités publiques et adaptent automatiquement le nom des méthodes aux conventions du langage.

Domaine fonctionnelCe que vous pouvez faire
WorkflowsRépertorier et lire les workflows, puis lancer une exécution de manière asynchrone.
ExécuterConsulter l'état, l'historique et le résultat final, ou annuler une exécution encore en cours.
LivrableLire les fichiers et les métadonnées d'artefacts produits par une exécution.
Approbation manuelleLire les approbations en attente et soumettre une décision d'approbation ou de refus.
WebhookEnregistrer et gérer des webhooks, consulter les statistiques et déclencher des workflows par webhook.

Démarrage rapide

  1. Créez une clé dans « Paramètres du compte → Clés API » et n'accordez que les scopes nécessaires à vos appels.
  2. Choisissez le client correspondant à votre environnement technique et ouvrez le README de son répertoire.
  3. Installez les dépendances depuis le code source et configurez l'API Key à l'aide d'une variable d'environnement.
  4. Créez un client API, puis appelez d'abord la liste des workflows pour vérifier la connexion et les autorisations.
terminalbash
python -m pip install "git+https://github.com/Braidrun/braidrun-sdk.git#subdirectory=python"
list_workflows.pypython
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)
Actuellement distribué sous forme de code source

Les SDK sont actuellement distribués via leur dépôt source GitHub, et leur disponibilité dans les gestionnaires de paquets propres à chaque langage peut varier. Référez-vous au README du répertoire concerné ; ne supposez pas que tous les clients ont été publiés dans un dépôt de paquets public.

Authentification et autorisations

Il est recommandé de lire l'API Key commençant par dyk_ depuis une variable d'environnement ou un service de gestion des secrets et d'utiliser un en-tête Bearer. N'inscrivez jamais une clé réelle dans le code source, les journaux ou le frontend du navigateur. Chaque endpoint vérifie toujours le scope requis ; un client fortement typé n'accorde pas automatiquement les autorisations.

La gestion des webhooks utilise une autre authentification

Les SDK génèrent également les API de gestion des webhooks, mais les endpoints d'administration sous /api/webhooks utilisent une session de navigateur ou un compte de service administrateur et n'acceptent pas les API Keys granulaires standard de la plateforme ouverte. Les endpoints de déclenchement de webhook peuvent toujours utiliser une clé de la plateforme ouverte dotée du scope WEBHOOK_TRIGGER.

Lorsque l'API renvoie 429, respectez Retry-After et utilisez X-RateLimit-Limit et X-RateLimit-Window pour ajuster la fréquence des nouvelles tentatives.

SDK ou moteur de workflows ?

ProjetAdapté à la scèneLieu d'exécution
braidrun-sdkAppelez l'API de la plateforme cloud Braidrun depuis votre application avec les types et modèles propres à chaque langage.Votre application + plateforme cloud Braidrun
braidrun-workflowExécutez des workflows YAML dans votre propre environnement ou intégrez le runtime dans un projet Kotlin/JVM.Environnements locaux, serveur ou CI que vous gérez

Voir la présentation complète des deux projets

Pages connexes