این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

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

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

مقدمه

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

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

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

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

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

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

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

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

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

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

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

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

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

افزودن شرایط و ضوابط با استفاده از 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
}

پذیرش سند شرایط و ضوابط برای یک توسعه‌دهنده یا شرکت با استفاده از 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

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

نکته : در payload پاسخ، auditDate روی زمان فعلی بر حسب UTC تنظیم شده است.

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

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

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

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

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

نام	توضیحات	پیش‌فرض	الزامی است؟
`url`	آدرس اینترنتی شرایط و ضوابط.	ناموجود	خیر
`tncText`	متن (مانند توضیح مختصر) برای شرایط و ضوابط.	ناموجود	خیر
`version`	نسخه شرایط و ضوابط. شماره نسخه به شما امکان می‌دهد نسخه‌های مختلف شرایط و ضوابط را پیگیری کنید.	ناموجود	بله
`startDate`	تاریخ لازم‌الاجرا شدن شرایط و ضوابط.	ناموجود	بله
`organization`	سازمان برای شرایط و ضوابط.	ناموجود	خیر

مراحل بعدی

یاد بگیرید که چگونه ارزهای پشتیبانی‌شده را به ارزهایی که در ابتدا برای سازمان شما تنظیم شده‌اند، در مدیریت ارزهای پشتیبانی‌شده اضافه کنید.