مدیریت شرایط خدمات

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید. اطلاعات

مقدمه

قبل‌از انتشار طرح نرخ، باید شرایط خدمات («ش‌خ») را به نمایه سازمانتان اضافه کنید. «شرایط خدمات» خارج از نمایه سازمان قرار دارد. در نمایه سازمانتان، مکان (نشانی وب عمومی) «شرایط خدمات» را مشخص می‌کنید.

پس‌از انتشار طرح نرخ، نسخه فعلی «شرایط خدمات» در درگاه توسعه‌دهنده نمایش داده می‌شود. توسعه‌دهندگان تنها پس‌از پذیرفتن «شرایط خدمات» فعلی می‌توانند طرح خریداری کنند.

افزودن شرایط خدمات بااستفاده از واسط کاربر

  1. به صفحه «نمایه سازمان» دسترسی پیدا کنید، همان‌طور که در کاوش صفحه «نمایه سازمان» توضیح داده شده است.
  2. روی ویرایش کلیک کنید.
  3. در بخش «شرایط خدمات» در صفحه «نمایه سازمان»، روی افزودن شرایط خدمات کلیک کنید.

    کادر گفتگوی «شرایط خدمات» جدید نمایش داده می‌شود

  4. اطلاعات زیر را وارد کنید:
    فیلد شرح
    تاریخ اجرا

    تاریخی که شرایط خدمات اجرایی می‌شود. پیش‌فرض تاریخ فعلی است. باید تاریخ فعلی یا آینده را وارد کنید.
    نسخه

    نسخه شرایط خدمات. شماره نسخه به شما امکان می‌دهد نسخه‌های مختلف شرایط خدمات را پیگیری کنید.
    نشانی وب

    نشانی وب شرایط خدمات.
  5. روی ایجاد کردن کلیک کنید.

    «شرایط خدمات» جدید به بخش «شرایط خدمات» صفحه «نمایه سازمان» اضافه می‌شود.

  6. مراحل ۳ تا ۵ را تکرار کنید تا شرایط خدمات اضافه را اضافه کنید.
  7. برای ذخیره کردن تغییرات نمایه سازمان، روی ذخیره کلیک کنید.

ویرایش شرایط خدمات بااستفاده از میانای کاربر

نمی‌توانید «شرایط خدمات» را مستقیماً ویرایش کنید. درعوض، باید شرایط خدماتی را که می‌خواهید ویرایش کنید حذف کنید و سپس ورودی شرایط خدمات جدیدی اضافه کنید.

حذف شرایط خدمات بااستفاده از واسط کاربر

  1. به صفحه «نمایه سازمان» دسترسی پیدا کنید، همان‌طور که در کاوش صفحه «نمایه سازمان» توضیح داده شده است.
  2. در صفحه «نمایه سازمان»، روی ویرایش کلیک کنید.
  3. در فهرست «شرایط خدمات»، مکان‌نما را روی «شرایط خدمات» موردنظرتان برای حذف کردن قرار دهید.
  4. روی کلیک کنید.

مدیریت شرایط خدمات بااستفاده از میانای برنامه‌سازی کاربردی

شرایط خدمات را بااستفاده از «میانای برنامه‌سازی کاربردی» مدیریت کنید، همان‌طور که در بخش‌های زیر توضیح داده شده است.

افزودن شرایط خدمات بااستفاده از API

با صدور درخواست POST به /mint/organizations/{org_name}/tncs، «شرایط خدمات» را اضافه کنید. وقتی «شرایط خدمات» را اضافه می‌کنید، می‌توانید به‌صورت اختیاری موارد زیر را مشخص کنید:

  • نشانی وب
  • نوشتار همراه (مثل شرح)
  • تاریخی که «شرایط خدمات» اجرایی می‌شود
  • شماره نسخه

برای اطلاعات بیشتر درباره این گزینه‌ها، دارایی‌های پیکربندی شرایط خدمات را ببینید.

برای مثال:

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"
 }

مشاهده شرایط خدمات بااستفاده از API

«شرایط خدمات» خاص یا همه «شرایط خدمات» سازمان را مشاهده کنید.

با صدور درخواست 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"
 }

حذف شرایط خدمات بااستفاده از API

با صدور درخواست 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

دارایی‌های پیکربندی شرایط خدمات برای API

جدول زیر مشخصه‌های پیکربندی را که می‌توان بااستفاده از میانای برنامه‌سازی کاربردی برای شرایط خدمات تنظیم کرد خلاصه می‌کند.

نام شرح پیش‌فرض الزامی است؟
url

نشانی وب «شرایط خدمات».

 موجود نیست نه
tncText

نوشتار (مثل شرح کوتاه) برای «شرایط خدمات».

 موجود نیست نه
version

نسخه «شرایط خدمات». شماره نسخه به شما امکان می‌دهد نسخه‌های مختلف «شرایط خدمات» را پیگیری کنید.

 موجود نیست بله
startDate

تاریخی که «شرایط خدمات» اعمال می‌شود.

 موجود نیست بله
organization

سازمان برای «شرایط خدمات».

 موجود نیست نه

مراحل بعدی

با نحوه افزودن ارزهای پشتیبانی‌شده به ارزهایی که در ابتدا برای سازمانتان تنظیم شده‌اند در مدیریت ارزهای پشتیبانی‌شده آشنا شوید.