شرایط و ضوابط را مدیریت کنید

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

مقدمه

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

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

افزودن شرایط و ضوابط با استفاده از UI

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

   گفتگوی شرایط و ضوابط جدید نمایش داده می شود

4. اطلاعات زیر را وارد کنید:

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

5. روی ایجاد کلیک کنید.

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

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

ویرایش شرایط و ضوابط با استفاده از رابط کاربری

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

حذف شرایط و ضوابط با استفاده از UI

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

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

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

افزودن شرایط و ضوابط با استفاده از یک API

T&C را با ارسال یک درخواست POST به /mint/organizations/ {org_name} /tncs اضافه کنید. هنگامی که T&C را اضافه می کنید، می توانید به صورت اختیاری مشخص کنید:

• URL
• متن همراه (مانند توضیحات)
• تاریخی که T&Cها در حال اجرا هستند
• شماره نسخه

برای اطلاعات بیشتر در مورد این گزینه ها ، ویژگی های پیکربندی شرایط و ضوابط را ببینید.

به عنوان مثال:

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

T&Cهای خاص یا همه T&Cهای یک سازمان را مشاهده کنید.

T&Cهای خاص را با ارسال یک درخواست GET به /mint/organizations/ {org_name} /tncs/ {tncs_id} مشاهده کنید، که در آن {tncs_id} شناسایی T&Cهای خاص است (هنگامی که T&Cها را ایجاد می کنید، شناسه در پاسخ بازگردانده می شود). به عنوان مثال:

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 همه T&Cهای سازمان را مشاهده کنید. به عنوان مثال:

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
}

پذیرش سند شرایط و ضوابط برای توسعه دهنده یا شرکتی که از API استفاده می کند

با صدور یک درخواست POST به یکی از API های زیر، یک سند T&C را برای یک توسعه دهنده یا شرکت خاص بپذیرید:

• /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

در زیر نمونه ای از پاسخ ارائه شده است:

{
  "action": "ACCEPTED",
  "auditDate": "2018-10-01 07:24:45",
  "id": "dev2@myorg.com",
  "tnc": {
      "id": "5a291b86-42e3-4ae1-8db3-efe4b0877316",
      ...
  }
}

مشاهده شرایط و ضوابط پذیرفته شده توسط یک توسعه دهنده یا شرکت با استفاده از API

T&Cهای پذیرفته شده توسط یک توسعه دهنده یا شرکت خاص را با صدور یک درخواست GET به ترتیب به یکی از API های زیر مشاهده کنید:

• /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
}

ویرایش شرایط و ضوابط با استفاده از API

T&C را با ارسال یک درخواست PUT به /mint/organizations/ {org_named} /tncs/ {tncs_id} ویرایش کنید، جایی که {tncs_id} شناسه T&Cها است. هنگامی که به‌روزرسانی را انجام می‌دهید، باید تنظیمات به‌روزرسانی شده و شناسایی T&Cها را در بدنه درخواست مشخص کنید. به عنوان مثال، درخواست زیر شماره نسخه T&C را ویرایش می کند (ویژگی به روز شده در مثال برجسته شده است):

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

T&C را با ارسال یک درخواست DELETE به /mint/organizations/ {org_name} /tncs/ {tncs_id} ، که در آن {tncs_id} شناسایی T&Cها است، حذف کنید. به عنوان مثال:

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

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

مراحل بعدی

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