إدارة الأحكام والشروط

أنت تعرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X. info

مقدمة

عليك إضافة الأحكام والشروط إلى الملف الشخصي لمؤسستك قبل نشر خطة أسعار. تقع بنود الخدمة والأحكام خارج ملف تعريف المؤسسة. في ملف مؤسستك الشخصي، يمكنك تحديد الموقع الجغرافي (عنوان URL متاح للجميع) لبنود الخدمة والأحكام.

بعد نشر خطة تعرفات، يتم عرض الإصدار الحالي من"بنود الخدمة" فيبوابة المطوّرين. لا يمكن للمطوّرين شراء خطة إلا بعد قبول بنود الخدمة الحالية.

إضافة الأحكام والشروط باستخدام واجهة المستخدم

  1. انتقِل إلى صفحة "الملف الشخصي للمؤسسة"، كما هو موضّح في مقالة استكشاف صفحة "الملف الشخصي للمؤسسة".
  2. انقر على تعديل.
  3. في قسم "الأحكام والشروط" من صفحة "ملف المؤسسة"، انقر على إضافة أحكام وشروط.

    يتم عرض مربّع الحوار "الأحكام والشروط الجديدة".

  4. أدخل المعلومات التالية:
    الحقل الوصف
    تاريخ السريان

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

    إصدار الأحكام والشروط يتيح لك رقم الإصدار تتبُّع الإصدارات المختلفة من الأحكام والشروط.
    عنوان URL

    عنوان URL للأحكام والشروط
  5. انقر على إنشاء.

    تتم إضافة "الأحكام والشروط" الجديدة إلى قسم "الأحكام والشروط" في صفحة "ملفّ المعهد" .

  6. كرِّر الخطوات من 3 إلى 5 لإضافة أحكام وشروط إضافية.
  7. انقر على حفظ لحفظ التغييرات في الملف الشخصي للمؤسسة.

تعديل الأحكام والشروط باستخدام واجهة المستخدم

لا يمكنك تعديل "الأحكام والشروط" مباشرةً. وبدلاً من ذلك، عليك حذف الأحكام والشروط التي تريد تعديلها، ثم إضافة إدخال جديد للأحكام والشروط.

حذف الأحكام والشروط باستخدام واجهة المستخدم

  1. انتقِل إلى صفحة "الملف الشخصي للمؤسسة"، كما هو موضّح في مقالة استكشاف صفحة "الملف الشخصي للمؤسسة".
  2. انقر على تعديل في صفحة "الملف الشخصي للمؤسسة".
  3. في قائمة"بنود الخدمة"، ضع مؤشر الماوس فوق"بنود الخدمة" التي تريد حذفها.
  4. انقر على .

إدارة الأحكام والشروط باستخدام واجهة برمجة التطبيقات

يمكنك إدارة الأحكام والشروط باستخدام واجهة برمجة التطبيقات، كما هو موضّح في الأقسام التالية.

إضافة الأحكام والشروط باستخدام واجهة برمجة التطبيقات

أضِف بنود الخدمة من خلال إرسال طلب 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 على الوقت الحالي بالتوقيت العالمي المنسّق (UTC).
{
  "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"
 }

حذف الأحكام والشروط باستخدام واجهة برمجة التطبيقات

يمكنك حذف الأحكام والشروط من خلال إصدار طلب حذف إلى /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

تمثّل هذه السمة منظمة للأحكام والشروط.

 لا ينطبق لا

الخطوات التالية

تعرَّف على كيفية إضافة عملات مسموح بها إلى العملات التي تم إعدادها في البداية لمؤسستك في مقالة إدارة العملات المسموح بها.