Birlesa منصة للتجارة بين الشركات: صفحات شركات مبنية من السجلات الرسمية، واحتياجات المشترين مطابَقة مع الموردين، وعروض أسعار، وصفقات، ومدفوعات محفوظة في حساب ضمان. تشرح هذه الصفحات كيف يعمل برنامجك معها.
| تريد أن | استخدم |
|---|---|
| تقرأ البيانات العامة: الشركات، والفرص، والمؤشر الشهري، ومتطلبات التصدير | واجهة REST البرمجية، دون مفتاح أو بمفتاح لميزانية أعلى |
| تعمل باسم مؤسستك: تنشر احتياجات، وتطلب عروض أسعار من الموردين | واجهة REST البرمجية أو خادم MCP، بمفتاح API يملك الصلاحية اللازمة |
| تعرف متى يحدث شيء يخص مؤسستك | خطافات الويب |
| تقرأ السجلات التي يذكرها خطاف الويب (الاحتياجات، والصفقات، وعروض الأسعار، وحسابات الضمان، والشحنات) | /v1/org/... بمفتاح org:read |
| تمنح وكيل ذكاء اصطناعي أدوات Birlesa | خادم MCP على /mcp |
| تستخدم بيانات سوق مجمّعة بموجب عقد (البنوك، والاتحادات، والجهات العامة) | منتجات البيانات |
العنوان الأساسي والصيغ
- بيئة الإنتاج:
https://api.birlesa.com. الوصول إلى البيئة التجريبية غير متاح بعد (البيئة التجريبية). - الطلبات والاستجابات بصيغة JSON (بترميز UTF-8). الأوقات بصيغة RFC 3339 وبالتوقيت العالمي المنسق (UTC). المبالغ المالية سلاسل نصية عشرية (
"1250.00")، ولا تكون أبدًا أعدادًا ذات فاصلة عائمة. البلدان برموز ISO 3166-1 alpha-2 (TR،SA)؛ ويدلEUوGCCعلى تكتلات حيث ينص الحقل على ذلك. - العقد الكامل هو وثيقة OpenAPI، على birlesa.com/openapi.json(يُفتح في علامة تبويب جديدة). كل عملية وحقل ورمز خطأ مُدرج فيها.
الصفحات
- المصادقة: مفاتيح API، وبيانات اعتماد عملاء OAuth، والصلاحيات.
- الحدود والحصص: حدود المعدل، والحصص اليومية، والاستخدام.
- الأخطاء: صيغة وثيقة المشكلة والرموز التي ستصادفها.
- خطافات الويب: نقاط الاستقبال، والتواقيع، وإعادة المحاولة. ويسرد دليل الأحداث كل حدث.
- الإصدارات والإيقاف: ما قد يتغير في
/v1، وكيف يُعلَن عن الإزالة. - خادم MCP: أدوات لوكلاء الذكاء الاصطناعي.
- البيئة التجريبية: البناء والاختبار مقابل شركاء وهميين وبيانات اختبار (غير متاحة بعد).
- مستويات الخدمة: ما نسعى إليه، وكيف نخبرك حين لا نبلغه.
- منتجات البيانات: مجموعات بيانات مجمّعة بموجب عقد.
قواعد أساسية
- احتفظ بالأسرار (مفاتيح API، وأسرار العملاء، وأسرار خطافات الويب) على خوادمك. تُعرض مرة واحدة فقط؛ ولا نحتفظ إلا ببصمتها المجزّأة (hash) أو بنسخة مختومة منها، ولا يمكننا عرضها مرة أخرى. إذا تسرّب أحدها، فألغِه وأصدِر بديلًا جديدًا.
- تبقى البيانات الشخصية خارج الواجهة البرمجية بحكم التصميم. تحمل خطافات الويب معرّفات، لا نصوصًا ولا أسماء. ويقرأ الأشخاص رسائل المحادثات في لوحة التحكم، لا عبر المفاتيح.
- كل ما يفعله التكامل يُسجَّل باسم مفتاحه أو عميله في سجل التدقيق الخاص بمؤسستك.