Как управлять условиями использования

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

Введение

Прежде чем опубликовать тарифный план, добавьте в профиль организации условия использования. Условия использования хранятся вне профиля организации. В профиле организации укажите местоположение (общедоступный 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} – идентификатор нужных условий (он возвращается в ответе при создании условий). Пример:

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

Ниже приведен пример ответа.

{
  "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 для условий использования.

Дальнейшие действия

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