connector-catalog-public@1.0.0
الكتالوج العام للموصلات
اطّلع على أنواع الموصلات التي نشرتها Apus ومدى جاهزية كل نوع. لا تلزم المصادقة.
مبني من العقد المجمّد، الإصدار 1.0.0. الإصدارات المجمّدة لا تُعدَّل أبداً.
العمليات
get/v1/public/connectors
يعيد الكتالوج كاملاً في استجابة واحدة دون تقسيم إلى صفحات. أرسل If-None-Match مع قيمة ETag المحفوظة لتحصل على 304 إذا لم يتغير شيء.
لا تلزم المصادقة · getPublicConnectorCatalog
المعاملات
| الاسم | الموضع | النوع | إلزامي |
|---|---|---|---|
| If-None-Match | header | string | لا |
الاستجابات
200— الكتالوج الحالي. المصفوفة الفارغة صالحة وتعني أنه لم يُنشر أي نوع بعد.304— لم يتغير الكتالوج منذ قيمة ETag المرسلة.500— تعذّر إنشاء الكتالوج. تعامل معه كغياب للبيانات، وليس ككتالوج فارغ.
نماذج البيانات
ConnectorCatalog
| الحقل | النوع | إلزامي | الوصف |
|---|---|---|---|
| contract | "connector-catalog-public/1.0.0" | نعم | إصدار العقد المقدَّم. |
| generated_at | string (date-time) | نعم | وقت إنشاء الكتالوج (UTC، RFC 3339). |
| connectors | PublicConnector[] | نعم | جميع الأنواع المنشورة؛ قد تكون فارغة. |
PublicConnector
| الحقل | النوع | إلزامي | الوصف |
|---|---|---|---|
| key | string | نعم | معرّف دائم لنوع الموصل؛ آمن للاستخدام كمرساة رابط. |
| name | string | نعم | اسم العرض؛ لا تستخدمه للمطابقة. |
| direction | inbound_api | webhook_out | polling_adapter | نعم | اتجاه البيانات: واردة عبر API، أو صادرة عبر Webhook موقّع، أو سحب دوري. |
| status | live | beta | roadmap | نعم | الجاهزية: live أو beta أو roadmap. |
| summary | string | لا | وصف قصير اختياري. |
| docs_url | string (uri) | لا | صفحة توثيق عامة اختيارية لهذا النوع. |