نظرة عامة

نظرة عامة #

يمكن استخدام API لإدارة الخصائص على حسابك. توضح المعلومات أدناه التنسيق المستخدم لطلبات واستجابات API.

مواقع الموارد والقاعدة URL #

اعتمادا على المنطقة التي يوجد فيها مثيل ~.Dimensions.~ الموجودة فيها، هناك روابط URL مختلفة للوصول إلى موارد واجهة برمجة التطبيقات. يرجى استخدام الجدول أدناه للعثور على القاعدة الصحيحة URL لمنطقتك.

المنطقة الأساس URL
أستراليا / نيوزيلندا https://api.au.myreports.cloud
أوروبا https://api.eu.myreports.cloud
أمريكا الشمالية https://api.na.myreports.cloud
المملكة المتحدة https://api.uk.myreports.cloud

بمجرد تحديد الأساس URL لمنطقتك، يتم عرض تنسيق أي طلبات API أدناه:

{BASE_URL}/api/{VERSION}/{RESOURCE}

مثلا.

https://api.na.myreports.cloud/api/v1.0/contactdirectories

API التفاعل #

يتطلب API استخدام تعريفات تنسيق JSON لمحتوى أي طلبات. سيتم إرجاع أي ردود بصيغة JSON باستخدام القالب التالي:

 
{ 
	"data": {
		<returned data>
	}, 
	"الخطأ": <errorCode>, 
	"رسالة": <message>, 
	"الحالة": <status>, 
	"الطابع الزمني": <timestamp UTC>
}
Hand Left warning
بعض الحقول قد لا يتم إرجاعها دائما

إذا كان data المرتج مجموعة، فسيعيد مصفوفة بحجم الصفحة.

 
{ 
	"page_size": "<number of items>", 
	"data": [{ 
			"معرف": "90ce2cce-5b90-424b-b502-55924f140a48", 
		}, { 
			"معرف": "EC52F7b1-1b74-498E-A49B-59b71022c3a1", 
		}
	][{
			"id": "90ce2cce-5b90-424b-b502-55924f140a48",
		}, {
			"id": "ec52f7b1-1b74-498e-a49b-59b71022c3a1",
		}
	]، 
	"المكانة": "نجاح", 
	"الطابع الزمني": "<timestamp in UTC>"
}

API الموارد #

يوفر الجدول التالي مخططا للموارد التي يوفرها API وصولا إليها:

المصدر الوصف
الأدلة استعلام الأدلة وإدارة عناصر الدليل الفردية.
مساحات العمل استعلام مساحات العمل المكونة، استعلام وتشغيل التقارير المكونة.

كل مورد يوفر الواجهات التالية للتفاعل:

الواجهة الوصف
احصل على الجميع يرجع مجموعة من جميع العناصر التي تطابق نوع الموارد.
اذهب... يعيد نسخة محددة من نوع المورد.
خلق... ينشئ نسخة جديدة من نوع الموارد.
باتش... يقوم بتحديث نسخة موجودة من نوع الموارد.
حذف... يزيل نسخة موجودة من نوع مورد.