مقدمة إلى واجهة برمجة Microsoft Dataverse تطبيقات الويب

  • 10 دقائق

واجهة برمجة تطبيقات الويب مقابل خدمة المؤسسة

تعد واجهة برمجة تطبيقات الويب وخدمة المؤسسة طريقتين رئيسيتين للتفاعل مع البيانات وبيانات التعريف فِي Microsoft Dataverse. يمكنك استخدام خدمة المؤسسة عند كتابة المكونات الإضافية أو ملحقات سير العمل باستخدام SDK لـ .NET الذي توفره Microsoft.

بغض النظر عن النهج الذي تتبعه، فإن جميع عمليات البيانات تمر عبر خدمة المؤسسة الأساسية. على هذا النحو، تتيح لك Web API إجراء نفس العمليات مثل خدمة المؤسسة ولكن بأسلوب RESTful.

الرسم التالي عبارة عن شجرة قرارات يمكن أن تساعدك فِي تحديد وقت استخدام Web API مقابل خدمة المؤسسة (من خلال تجميعات SDK المتوفرة فِي حزمة Microsoft.CrmSdk.CoreAssemblies NuGet). ويوضح أيضًا متى يتم استخدام تجميعات Dataverse ServiceClient (المتوفرة فِي حزمة Microsoft.PowerPlatform.Dataverse.Client NuGet) لتطبيقات Windows.

شجرة القرار للمساعدة فِي تحديد متى يتم استخدام Web API مقابل خدمة المؤسسة وأيضًا متى يتم استخدام تجميعات أدوات XRM لتطبيقات Windows.

تركز هذه الوحدة على واجهة API للويب. لمزيد من المعلومات حول خدمة المؤسسة، راجع استخدام خدمة Dataverse Organization فِي دليل مطور Dataverse.

OData (بروتوكول البيانات المفتوحة) 4.0

Dataverse يتم تنفيذ Web API كخدمة OData (بروتوكول البيانات المفتوحة OASIS). يوفر استخدام معيار الصناعة مثل هذا جميع فوائد تطوير المعايير المفتوحة، مثل التوافق عبر الأنظمة الأساسية والتنفيذ البسيط مقابل بروتوكول مشترك محدد مسبقًا.

Dataverse لا توفر أدوات .NET محددة لواجهة API للويب. بدلاً من ذلك، نوصي باستخدام مكتبات المجتمع التي تتوافق مع بروتوكول OData. إذا كنت تريد المزيد من المعلومات حول المكتبات الموجودة، راجع https://www.odata.org/libraries/.

تتيح لك OData التفاعل مع بيانات Dataverse من خلال عمليات CRUD (الإنشاء والقراءة والتحديث والحذف) المتوفرة من خلال الأساليب GET وPOST وPATCH وDELETE HTTP القياسية. (يمكنك العثور على مزيد من المعلومات حول هذه الطرق لاحقًا فِي هذه الوحدة.) يمكنك أيضًا تنفيذ أي عملية أخرى تقريبًا يتم كشفها من خلال Dataverse إطار عمل الحدث عن طريق استدعاء وظيفة أو إجراء OData يحمل نفس اسم رسالة خدمة المؤسسة المقابلة لها. الرسائل المتعلقة بـ CRUD هي الوحيدة غير المتوفرة لأن هذه الرسائل تستخدم أساليب HTTP القياسية الموضحة مسبقًا.

REST

في الأساس، بروتوكول OData عبارة عن مجموعة من واجهات برمجة التطبيقات RESTful ( نقل الحالة التمثيلية )، وهو معيار صناعي لتوفير إمكانية التشغيل البيني بين الأنظمة. يتكون REST من ستة مبادئ توجيهية تقيد كيفية معالجة الخدمة للطلبات والاستجابة لها لضمان استيفاء الخصائص غير الوظيفية لتلك الخدمة (مثل الأداء وقابلية التوسع والبساطة والموثوقية وما إلى ذلك).

في هذا الدرس، يجب أن تضع فِي اعتبارك أن OData يتوافق مع هذه القيود وأن Dataverse Web API الذي ينفذ بروتوكول OData يتوافق أيضًا مع القيود.

FetchXML

FetchXML هي لغة استعلام قوية تسمح بالاستعلام المعقد عن بيانات Dataverse. يمكنك استخدام FetchXML لإنشاء معايير الاستعلام الخاصة بك عند تشغيل الاستعلامات باستخدام Dataverse Web API. يمكن أن يكون هذا الأسلوب ذا قيمة إذا واجهت سيناريو حيث يناسب FetchXML استعلامك بشكل أفضل من بناء جملة استعلام OData. يمكنك العثور على مزيد من المعلومات حول وحدة FetchXML الأحدث فِي هذه الوحدة.