أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلىمستندات Apigee X. info
مقدمة
عليك إضافة الأحكام والشروط إلى ملف تعريف مؤسستك قبل نشر خطة أسعار. تقع الأحكام والشروط خارج ملف تعريف المؤسسة. في ملف تعريف مؤسستك، يمكنك تحديد موقع الأحكام والشروط (عنوان URL علني) للـ
بعد نشر خطة أسعار، يتم عرض الإصدار الحالي من الأحكام والشروط في بوابة مخصّصة للمطوّرين. لا يمكن للمطوّرين شراء خطة إلا بعد قبول الأحكام والشروط الحالية.
إضافة الأحكام والشروط باستخدام واجهة المستخدم
- يمكنك الوصول إلى صفحة "ملف تعريف المؤسسة" كما هو موضّح في مقالة استكشاف صفحة "ملف تعريف المؤسسة".
- انقر على تعديل.
- في قسم "الأحكام والشروط" من صفحة "ملف تعريف المؤسسة"، انقر على إضافة الأحكام و
الشروط.
يظهر مربّع الحوار "الأحكام والشروط الجديدة"
- أدخل المعلومات التالية:
الحقل الوصف تاريخ السريان التاريخ الذي تصبح فيه الأحكام والشروط سارية المفعول التاريخ الحالي هو التاريخ التلقائي. عليك إدخال التاريخ الحالي أو تاريخ في المستقبل.
الإصدار إصدار الأحكام والشروط يتيح لك رقم الإصدار تتبُّع الإصدارات المختلفة من الأحكام والشروط.
عنوان URL عنوان URL للأحكام والشروط
- انقر على إنشاء.
تتم إضافة الأحكام والشروط الجديدة إلى قسم "الأحكام والشروط" في صفحة "ملف تعريف المؤسسة" .
- كرِّر الخطوات من 3 إلى 5 لإضافة بنود إضافية.
- انقر على حفظ لحفظ التغييرات في ملف تعريف المؤسسة.
تعديل الأحكام والشروط باستخدام واجهة المستخدم
لا يمكنك تعديل الأحكام والشروط مباشرةً. بدلاً من ذلك، عليك حذف الأحكام والشروط التي تريد تعديلها ثم إضافة إدخال جديد للأحكام والشروط.
حذف الأحكام والشروط باستخدام واجهة المستخدم
- يمكنك الوصول إلى صفحة "ملف تعريف المؤسسة" كما هو موضّح في مقالة استكشاف صفحة "ملف تعريف المؤسسة".
- انقر على تعديل في صفحة "ملف تعريف المؤسسة".
- في قائمة الأحكام والشروط، ضَع المؤشر على الأحكام والشروط التي تريد حذفها.
- انقر على
.
إدارة الأحكام والشروط باستخدام واجهة برمجة التطبيقات
يمكنك إدارة الأحكام والشروط باستخدام واجهة برمجة التطبيقات كما هو موضّح في الأقسام التالية.
إضافة الأحكام والشروط باستخدام واجهة برمجة تطبيقات
يمكنك إضافة الأحكام والشروط من خلال إرسال طلب POST إلى /mint/organizations/{org_name}/tncs.
عند إضافة الأحكام والشروط، يمكنك اختياريًا تحديد ما يلي:
- عنوان URL
- نص مصاحب (مثل وصف)
- التاريخ الذي تصبح فيه الأحكام والشروط سارية المفعول
- رقم الإصدار
لمزيد من المعلومات حول هذه الخيارات، اطّلِع على مقالة خصائص إعداد الأحكام والشروط.
على سبيل المثال:
curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
-H "Content-Type: application/json" \
-d \
'{
"url":"www.testoperator/termsandconditions",
"tncText":"Sample text for the T&C",
"version":"1.1",
"startDate":"2018-09-24"
}' \
-u email:password
فيما يلي مثال على الردّ:
{
"id" : "6803d70a-18cc-40c8-b250-675c5e8a75c ",
"organization" : {
…
},
"startDate" : "2018-09-24 00:00:00",
"tncText" : "Sample text for the T&C",
"url" : "www.testoperator/termsandconditions",
"version" : "1.1"
}عرض الأحكام والشروط باستخدام واجهة برمجة التطبيقات
يمكنك عرض أحكام وشروط معيّنة أو جميع الأحكام والشروط لمؤسسة.
يمكنك عرض أحكام وشروط معيّنة
من خلال إرسال طلب استرداد بيانات باستخدام GET إلى /mint/organizations/{org_name}/tncs/{tncs_id}، حيث يكون
{tncs_id} هو تعريف الأحكام والشروط المحدّدة (يتم عرض رقم التعريف في الردّ
عند إنشاء الأحكام والشروط). على سبيل المثال:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs/6803d70a-18cc-40c8-b250-675c5e8a75c" \
-H "Accept: application/json" \
-u email:password
يمكنك عرض جميع الأحكام والشروط للمؤسسة من خلال إرسال طلب استرداد بيانات باستخدام GET إلى
/mint/organizations/{org_name}/tncs. على سبيل المثال:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs" \
-H "Accept: application/json" \
-u email:password
فيما يلي مثال على الردّ:
{
"tnc" : [
{
"id" : "77193339-8d79-44a8-8af2-3593f16c158e",
"organization" :
{
...
},
"startDate" : "2018-07-01 00:00:00",
"tncText" : "Big operator text for the T&C",
"url" : "www.bigoperator/termsandconditions",
"version" : "1.0"
},
{
"id" : "6803d70a-18cc-40c8-b250-675c5e8a75c3",
"organization" : {
...
},
"startDate" : "2018-09-24 00:00:00",
"tncText" : "Sample text for the T&C",
"url" : "www.testoperator/termsandconditions",
"version" : "1.1"
}
]
"totalRecords" : 2
}قبول مستند الأحكام والشروط لمطوّر أو شركة باستخدام واجهة برمجة التطبيقات
يمكنك قبول مستند الأحكام والشروط لمطوّر أو شركة معيّنة من خلال إرسال طلب POST إلى إحدى واجهات برمجة التطبيقات التالية، على التوالي:
/mint/organizations/{org_name}/developers/{dev_id}/tncs/{tncs_id}/developer-tncs/mint/organizations/{org_name}/companies/{company_id}/tncs/{tncs_id}/developer-tncs
حيث يكون {dev_id} هو رقم تعريف المطوّر (عنوان البريد الإلكتروني)، و{company_id} هو رقم تعريف الشركة، و{tncs_id} هو رقم تعريف مستند الأحكام والشروط.
على سبيل المثال:
curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev2@myorg.com/tncs/5a291b86-42e3-4ae1-8db3-efe4b0877316/developer-tncs" \
-H "Content-Type: application/json" \
-d \
'{
"action":"ACCEPTED",
"auditDate":"2018-10-01 00:00:00"
}' \
-u email:password
فيما يلي مثال على الردّ:
auditDate على الوقت الحالي بالتوقيت العالمي المنسّق.{ "action": "ACCEPTED", "auditDate": "2018-10-01 07:24:45", "id": "dev2@myorg.com", "tnc": { "id": "5a291b86-42e3-4ae1-8db3-efe4b0877316", ... } }
عرض الأحكام والشروط التي قبلها مطوّر أو شركة باستخدام واجهة برمجة التطبيقات
يمكنك عرض الأحكام والشروط التي قبلها مطوّر أو شركة معيّنة من خلال إرسال طلب GET إلى إحدى واجهات برمجة التطبيقات التالية، على التوالي:
/mint/organizations/{org_name}/developers/{dev_id}/developer-tncs/mint/organizations/{org_name}/companies/{company_id}/developer-tncs
حيث يكون {dev_id} هو رقم تعريف المطوّر (عنوان البريد الإلكتروني) و{company_id} هو رقم تعريف الشركة.
على سبيل المثال:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/developers/dev2@myorg.com/developer-tncs" \
-H "Accept:application/json" \
-u email:password
فيما يلي مثال على الردّ:
{ "developerTnc": [ { "action": "ACCEPTED", "auditDate": "2018-08-29 07:24:45", "id": "dev2@myorg.com", "tnc": { "id": "26abc14c-c628-4c38-8840-a343c8ee9437", ... } }], "totalRecords": 1 }
تعديل الأحكام والشروط باستخدام واجهة برمجة التطبيقات
يمكنك تعديل الأحكام والشروط من خلال إرسال طلب PUT إلى
/mint/organizations/{org_named}/tncs/{tncs_id}, حيث يكون {tncs_id} هو الـ
تعريف للأحكام والشروط. عند إجراء التعديل، عليك تحديد الإعدادات المعدَّلة وتعريف الأحكام والشروط في نص الطلب. على سبيل المثال، يعدِّل الطلب التالي
رقم إصدار الأحكام والشروط (تم تمييز السمة المعدَّلة في الـ
مثال):
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/tncs/cfbb03b3-b707-495b-9b8a-ff67d71065a9" \
-H "Content-Type: application/json" \
-d {
"id":"6803d70a-18cc-40c8-b250-675c5e8a75c",
"version":"1.2"
}' \
-u email:password
فيما يلي مثال على الردّ:
{ "id" : "cfbb03b3-b707-495b-9b8a-ff67d71065a9", "organization" : { "address" : [ { "address1" : "Test address", "city" : "Test City", "country" : "US", "id" : "test-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], …" }, "startDate" : "2018-09-24 00:00:00", "tncText" : "Sample text for the T&C", "url" : "www.testoperator/termsandconditions", "version" : "1.2" }
حذف الأحكام والشروط باستخدام واجهة برمجة التطبيقات
يمكنك حذف الأحكام والشروط من خلال إرسال طلب DELETE إلى
/mint/organizations/{org_name}/tncs/{tncs_id}, حيث يكون {tncs_id} هو الـ
تعريف الأحكام والشروط. على سبيل المثال:
curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/tncs/6803d70a-18cc-40c8-b250-675c5e8a75c" \ -H "Accept: application/json" \ -u email:password
خصائص إعداد الأحكام والشروط لواجهة برمجة التطبيقات
يلخّص الجدول التالي خصائص الإعداد التي يمكن ضبطها باستخدام واجهة برمجة التطبيقات للأحكام والشروط.
| الاسم | الوصف | تلقائي | مطلوب؟ |
|---|---|---|---|
url |
عنوان URL للأحكام والشروط |
لا ينطبق | لا |
tncText |
نص الأحكام والشروط (مثل وصف موجز) |
لا ينطبق | لا |
version |
إصدار الأحكام والشروط يتيح لك رقم الإصدار تتبُّع الإصدارات المختلفة من الأحكام والشروط. |
لا ينطبق | نعم |
startDate |
التاريخ الذي تصبح فيه الأحكام والشروط سارية المفعول |
لا ينطبق | نعم |
organization |
المؤسسة التي تنطبق عليها الأحكام والشروط |
لا ينطبق | لا |
الخطوات التالية
تعرَّف على كيفية إضافة العملات المتاحة إلى العملات التي تم إعدادها في البداية لمؤسستك في مقالة إدارة العملات المتاحة.