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

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X.
المعلومات

مقدمة

يجب إضافة أحكام وشروط إلى الملف الشخصي لمؤسستك قبل نشر خطة أسعار. تكون الأحكام والشروط خارج الملف الشخصي للمؤسسة. في ملفك الشخصي لمؤسستك، عليك تحديد الموقع الجغرافي (عنوان 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 على الوقت الحالي بالتوقيت العالمي المنسَّق.
{
  "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

تنظيم الأحكام والشروط

لا ينطبق لا

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

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