# وثائق API
يتكون API DDB من عدد من الخدمات المجهرية المختلفة. يمكنك أدناه رؤية الخدمات المختلفة التي يمكنك التفاعل معها ، إلى جانب كيفية المصادقة والوصول.
# الخدمات المجهرية
تم فصل API لدينا إلى microservices.
| الخدمات المجهرية | الغرض |
|---|---|
| Comments Service | يستضيف التعليقات المترابطة التي تتعلق بمجموعة متنوعة من الأنظمة والأصول والمعلمات. |
| Environment Context Service | يخزن المشاريع الحالية في DDB ويربطها بأنظمة Arup الأوسع عبر الإعلانات. |
| Parameter Metadata Service | يوفر بيانات وصفية عن الأصول والمعلمات في المشاريع. |
| Parameter Service | يخزن بيانات الأصول والمعلمات في المشاريع ويحمل تصنيف DDB. |
| QA Service | يخزن بيانات ضمان الجودة المتعلقة بالمعلمات والإدخالات. |
| Reference Data Service | يحدد المراجع للمصادر الداخلية والخارجية. يحمل مصادر قيم المعلمات. |
| Template Service | يحمل هياكل قالب المعلمات والأصول التي يمكن استخدامها لإنشاء المحتوى والعمليات الآلية. |
| User Service | يدير أدوار المستخدمين في المشاريع لتحديد أذونات الوصول لكل مشروع. |
كل خدمة microservice لديها مثيل مستقل لكل من البيئات الثلاث. للحصول على خلاصة الغرض من كل بيئة ، انظر هنا .
يتضمن الجدول التالي روابط لكل خدمة microservice ، لكل بيئة.
| Microservice | *Development | Sandbox | Production |
|---|---|---|---|
| Comments Service | comments_service | comments_service | comments_service |
| Environment Context Service | environment_context_ service | environment_context_ service | environment_context_ service |
| Parameter Metadata Service | parameter_metadata_ service | parameter_metadata_ service | parameter_metadata_ service |
| Parameter Service | parameter_service | parameter_service | parameter_service |
| QA Service | qa_service | qa_service | qa_service |
| Reference Data Service | reference_data_ service | reference_data_ service | reference_data_ service |
| Template Service | template_service | template_service | template_service |
| User Service | user_service | user_service | user_service |
*يجب أن يستخدم فريق تطوير DDB فقط بيئة التطوير
تستخدم جميع الخدمات المختلفة عنوان URL الأساسي نفسه (على سبيل المثالhttps://ddb.arup.com (opens new window)) ويتم توجيهها وفقًا لعنوان URL الخاص بهم.
يتم تعريف كل خدمة microservice في استخدام Open API 3.0 (Swagger). إذا لم تكن متأكدًا من نقاط نهاية API المتعلقة بعملك ، فاتصل بفريق Onboarding للحصول على مزيد من الدعم.
# قريباً
| الخدمات المجهرية | الغرض |
|---|---|
| Audit Service | يخزن سجلاً لجميع الأحداث ويعيد سجل التغييرات ضمن نطاق معين. |
# تدفق API
يرسم الرسم البياني أدناه الخطوات التي يجب اتخاذها عند محاولة الحصول على المعلمات ونشرها إلى DDB.
رسم تخطيطي لمكالمات واجهة برمجة التطبيقات المطلوبة
