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

Вы просматриваете документацию 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

Примите документ T&C для конкретного разработчика или компании, отправив 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

Организация условий и условий.

 Н/Д Нет

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

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