انتقل إلى المحتوى الرئيسي

المقدمة

تقوم وحدة IntegrationCollections بتخزين البيانات المستخدمة لدمج خدمات وأنظمة مختلفة.

لدمج خدمات الطرف الثالث، تحتاج أولاً إلى إنشاء وتكوين المجموعات.

مزيد من المعلومات حول واجهة المستخدم الخاصة بالوحدة https://doc.oneentry.cloud/docs/category/integration-collections

🎯 ماذا تفعل هذه الوحدة؟​

تتيح لك وحدة IntegrationCollections قراءة وإدارة المجموعات — جداول منظمة من السجلات المستخدمة لدمج OneEntry مع الخدمات والأنظمة الخارجية. يتم تعريف كل مجموعة بواسطة نموذج (مخططها)؛ كل سجل (صف) يحمل formData المقدم.

قم بتعريف مجموعة ونموذجها في لوحة الإدارة، ثم استرجع، أنشئ، حدث، واحذف صفوفها من تطبيقك.

🚀 البدء السريع​

قم بتهيئة الوحدة من defineOneEntry:


const { IntegrationCollections } = defineOneEntry(
  "your-project-url", {
    "token": "your-app-token"
  }
);

استرجع جميع المجموعات واقرأ حقولها:

// Returns an array of collections (langCode defaults to the configured language).
const collections = await IntegrationCollections.getICollections("en_US");

collections.forEach((collection) => {
  console.log(collection.id, collection.identifier, collection.formId);
});

✨ المفاهيم الأساسية​

المجموعة مقابل الصف​

  • المجموعة (ICollectionEntity) — الحاوية/المخطط. تشير إلى نموذج (formId) ومجموعة سمات، وتحمل معلومات محلية.
  • الصف (ICollectionRow) — سجل واحد داخل مجموعة، يحمل formData (مصفوفة من { marker, type, value })، الطوابع الزمنية، وكيان مرتبط اختياري (entityType / entityId).

هيكل المجموعة​

{
  id: 1,
  identifier: 'collection1',
  formId: 1234,
  localizeInfos: { title: 'Admins text' },
  attributeSetId: 1234,
  selectedAttributeMarkers: 'collection_marker'
}

هيكل الصف​

{
  id: 1,
  createdDate: '2025-06-06T19:08:54.616Z',
  updatedDate: '2025-06-06T19:08:54.616Z',
  collectionId: 1,
  formData: [
    { marker: 'name_1', type: 'string', value: 'Value' }
  ],
  entityType: null,
  entityId: null,
  attributeSetIdentifier: null
}

إنشاء أو تحديث الصفوف​

مرر كائن نموذج (ICollectionFormObject) مع معرف النموذج وقيم الحقول:

const body = {
  formIdentifier: 'collection-form',
  formData: [
    { marker: 'collection_marker', type: 'string', value: 'Collection marker' }
  ]
};

await IntegrationCollections.createICollectionRow('collection1', body);

📋 ما تحتاج إلى معرفته​

يتم تعريف المجموعات في لوحة الإدارة​

يتم إنشاء وتكوين المجموعات ونماذجها في لوحة إدارة OneEntry. SDK مخصص لـ قراءة المجموعات و إدارة صفوفها (إنشاء / تحديث / حذف).

حذف الصفوف يتطلب إذنًا​

يتطلب deleteICollectionRowByMarkerAndId() الحق collections.row.delete؛ بدون ذلك، يفشل الحذف.

📊 جدول المرجع السريع​

الطريقةالوصف
getICollections()الحصول على جميع المجموعات.
getICollectionById()الحصول على مجموعة واحدة بواسطة المعرف.
getICollectionRowsById()الحصول على جميع صفوف مجموعة بواسطة معرف المجموعة.
getICollectionRowsByMarker()الحصول على جميع صفوف مجموعة بواسطة العلامة.
getICollectionRowByMarkerAndId()الحصول على صف واحد بواسطة علامة المجموعة ومعرف الصف.
validateICollectionMarker()التحقق مما إذا كانت علامة المجموعة موجودة.
createICollectionRow()إنشاء صف في مجموعة.
updateICollectionRow()تحديث صف في مجموعة.
deleteICollectionRowByMarkerAndId()حذف صف مجموعة (يتطلب الحق collections.row.delete).

❓ الأسئلة الشائعة (FAQ)​

أين يتم إنشاء المجموعات؟​

يتم إنشاء وتكوين المجموعات ونماذجها في لوحة إدارة OneEntry. SDK مخصص لـ قراءة المجموعات و إدارة صفوفها (إنشاء / تحديث / حذف).

ما الفرق بين المجموعة وصف المجموعة؟​

المجموعة هي تعريف الجدول (مخطط النموذج والبيانات الوصفية). صف المجموعة هو سجل واحد مخزن في تلك المجموعة، يحمل قيم formData الخاصة به.

🎓 أفضل الممارسات​

  • تعريف المجموعات في لوحة الإدارة - يقرأ SDK المجموعات ويدير صفوفها، وليس المخطط.
  • التحقق من العلامات قبل الاستخدام - استخدم validateICollectionMarker() لتأكيد وجود علامة مجموعة.
  • مطابقة حقول النموذج مع المخطط - يجب أن تتطابق علامات/أنواع formData مع نموذج المجموعة.
  • ضمان إذن الحذف - يحتاج deleteICollectionRowByMarkerAndId() إلى الحق collections.row.delete.

🔗 الوثائق ذات الصلة​