Braidrun SDK

Braidrun SDK هي المجموعة الرسمية من العملاء محددي الأنواع لواجهة API الخاصة بالمنصة المفتوحة. وهي تغلّف نقاط نهاية سير العمل والتنفيذ وملفات المخرجات والموافقات البشرية وخطافات الويب في أساليب ونماذج بيانات مألوفة لكل لغة، حتى لا تضطر إلى كتابة طلبات HTTP وأنواع الاستجابات يدويًا.

العملاء المدعومون

يوفر المستودع 13 تطبيقًا للعملاء تغطي 12 لغة. كل دليل عبارة عن عميل مستقل يضم بيانات تعريف الحزمة ونماذج API والاختبارات ووثائق كاملة لنقاط النهاية بتلك اللغة.

تغطية API

يغطي كل عميل لغوي الإمكانات العامة نفسها، مع تكييف أسماء الأساليب وفق أعراف اللغة.

البداية السريعة

1. أنشئ مفتاحًا ضمن «إعدادات الحساب ← مفاتيح API»، ولا تمنحه سوى النطاقات اللازمة لاستدعاءاتك.
2. اختر العميل المتوافق مع حزمة تقنياتك وافتح ملف README في دليله.
3. ثبّت التبعيات من الشفرة المصدرية واضبط مفتاح API عبر متغير بيئة.
4. أنشئ عميل API، ثم استدعِ قائمة مسارات العمل أولاً للتحقق من الاتصال والأذونات.

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)

المصادقة والأذونات

حمّل مفتاح API الذي يبدأ بـ dyk_ من متغير بيئة أو خدمة لإدارة الأسرار، واستخدم ترويسة Bearer. لا تكتب مفتاحًا حقيقيًا مطلقًا في الشفرة المصدرية أو السجلات أو شفرة واجهة المتصفح. تظل كل نقطة نهاية تتحقق من النطاق المطلوب؛ فالعميل محدد الأنواع لا يمنح الأذونات تلقائيًا.

عندما تعيد API الرمز 429، التزم بقيمة Retry-After واستخدم X-RateLimit-Limit وX-RateLimit-Window لضبط وتيرة إعادة المحاولة.

حزمة SDK أم محرك سير العمل؟

عرض النظرة العامة الكاملة للمشروعين

الصفحات ذات الصلة

• المنتدى المفتوح العضوية
• إدارة رئيسية
• التوثيق والحد من المعدل
• مرجع كامل للنقاط النهائية
• مستودع Braidrun SDK على GitHub ↗