Управление положениями и условиями

Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info

Введение

Перед публикацией тарифного плана необходимо добавить условия и положения («Условия») в профиль вашей организации. Условия и положения находятся вне профиля организации. В профиле организации вы указываете местоположение (общедоступный URL) Условий и положений.

После публикации тарифного плана текущая версия условий и положений отображается на портале для разработчиков. Разработчики могут приобрести тарифный план только после принятия текущих условий и положений.

Добавление условий использования с помощью пользовательского интерфейса.

  1. Перейдите на страницу «Профиль организации», как описано в разделе «Изучение страницы «Профиль организации»» .
  2. Нажмите «Редактировать» .
  3. В разделе «Условия и положения» на странице «Профиль организации» нажмите «Добавить условия и положения» .

    Отобразится диалоговое окно «Новые условия и положения».

  4. Введите следующую информацию:
    Поле Описание
    Дата вступления в силу

    Дата вступления в силу условий. По умолчанию используется текущая дата. Необходимо ввести текущую или будущую дату.

    Версия

    Версия условий и положений. Номер версии позволяет отслеживать различные версии условий и положений.

    URL

    URL-адрес условий использования.

  5. Нажмите «Создать» .

    Новые условия и положения добавлены в раздел «Условия и положения» на странице «Профиль организации».

  6. Повторите шаги с 3 по 5, чтобы добавить дополнительные условия.
  7. Нажмите «Сохранить» , чтобы сохранить изменения в профиле организации.

Редактирование условий использования с помощью пользовательского интерфейса.

Вы не можете редактировать условия напрямую. Вместо этого вам необходимо удалить условия, которые вы хотите отредактировать, а затем добавить новую запись в условия.

Удаление условий использования через пользовательский интерфейс.

  1. Перейдите на страницу «Профиль организации», как описано в разделе «Изучение страницы «Профиль организации»» .
  2. На странице «Профиль организации» нажмите кнопку «Редактировать» .
  3. В списке условий и положений наведите курсор на те условия, которые хотите удалить.
  4. Нажмите .

Управление условиями использования с помощью API

Управляйте условиями использования с помощью API, как описано в следующих разделах.

Добавление условий использования с помощью API.

Добавьте условия использования, отправив 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"
 }

Просмотр условий использования с помощью API

Просмотреть конкретные или все условия и положения для конкретной организации.

Чтобы просмотреть конкретные условия использования, отправьте GET-запрос по адресу /mint/organizations/ {org_name} /tncs/ {tncs_id} , где {tncs_id} — это идентификатор конкретных условий использования (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:

  • /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",
      ...
  }
}

Просмотр условий использования, принятых разработчиком или компанией, использующей 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

URL-адрес условий и положений.

 Н/Д Нет
tncText

Текст (например, краткое описание) для условий и положений.

 Н/Д Нет
version

Версия Условий и положений. Номер версии позволяет отслеживать различные версии Условий и положений.

 Н/Д Да
startDate

Дата вступления в силу настоящих Условий и положений.

 Н/Д Да
organization

Организация, занимающаяся разработкой условий и положений.

 Н/Д Нет

Следующие шаги

Узнайте, как добавить поддерживаемые валюты к тем, которые изначально были настроены для вашей организации, в разделе «Управление поддерживаемыми валютами» .