Управление продуктами API

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

Управление продуктами API осуществляется с помощью пользовательского интерфейса управления Apigee Edge, как описано в этом разделе. Для управления продуктами API с помощью самого API см. раздел «Использование API управления Edge для публикации API» .

Обзор продуктов API см. в разделе «Что такое продукт API?» .

Изучите страницу продуктов API.

Перейдите на страницу продуктов API, как описано ниже.

Добавление продукта API

Добавьте продукт API с помощью пользовательского интерфейса, как описано ниже. Чтобы использовать Edge API, см. раздел «Настройка продуктов API с помощью API» .

Чтобы добавить продукт API с помощью пользовательского интерфейса Edge:

1. Перейдите на страницу продуктов API , как описано ранее в этом разделе.
2. Нажмите +API Продукт .
3. Введите подробные сведения о вашем API-продукте.
   

   Поле	Описание
   Имя	Внутреннее имя продукта API. После создания продукта API изменить его нельзя. Не указывайте в имени специальные символы.
   Отображаемое имя	Отображаемое имя для продукта API. Отображаемое имя используется в пользовательском интерфейсе, и вы можете изменить его в любое время. Если не указано, будет использоваться значение «Имя». Это поле автоматически заполняется значением «Имя»; вы можете редактировать или удалять его содержимое. Отображаемое имя может содержать специальные символы.
   Описание	Описание продукта API.
   Среда	Среды, к которым API-продукт предоставит доступ. Например, test или prod .
   Доступ	Уровень доступа. Подробности см. в разделе «Уровень доступа» .
   Автоматическое одобрение запросов на доступ	Включите автоматическое подтверждение запросов ключей для этого API-продукта из любого приложения. Чтобы требовать ручного подтверждения ключей, отключите эту опцию. См. разделы «Регистрация приложений и управление ключами API (пользовательский интерфейс)» и «Ключи приложений разработчиков (API)».
   Квота	Ограничение квоты, на которое вы хотите ссылаться в политиках квот. Ввод значения квоты не приводит к автоматическому применению ограничений на количество вызовов, которые могут быть выполнены через продукт. API-прокси, на которые ссылается продукт, должны включать политику квот для обеспечения соблюдения квоты. Для получения дополнительной информации см. раздел «Квоты» .
   Разрешенные области действия OAuth	Если вы используете OAuth с API-продуктом, укажите разрешенные области действия OAuth, которые вы хотите разрешить API-продукту (например, Read или другие области действия, которые приложения будут отправлять со своими API-вызовами). Укажите несколько областей действия в виде списка, разделенного запятыми. См. раздел «Области действия OAuth» .

4. Добавьте ресурсы API , доступные в продукте API, включая прокси API и пути к ресурсам.

   Например, если вы добавите к продукту прокси-сервер API для доступа к музыке с базовым путем /music , продукт API разрешит вызовы к /music . Однако, если вы хотите, чтобы продукт API разрешал доступ только к ресурсу venues , URI которого равен /music/venues , добавьте ресурс /venues к продукту. В этом случае вызовы к /music/venues?name=paramount будут разрешены, но вызовы к /music/artists?name=Jack%Johnson будут заблокированы.

   Укажите конкретный путь к ресурсу или задайте базовый путь и все возможные подпути, указав путь к ресурсу как / . Путь к ресурсу может включать подстановочные знаки /** и /* . Подстановочный знак в виде двойной звездочки указывает на то, что поддерживаются все подпути базового пути (но не сам базовый путь). Одиночная звездочка указывает на то, что поддерживаются только URI на один уровень ниже базового пути. См. раздел «Настройка поведения пути к ресурсу для '/', '/*' и '/**'» , описанный далее в этом разделе.

   Для добавления ресурсов API:

   1. В разделе ресурсов API нажмите «Добавить прокси» или «Добавить путь» .
   2. Выберите, хотите ли вы добавить API-прокси , путь или и то, и другое : API-прокси и путь .

      

   3. Добавьте один или несколько API-прокси и путей к ресурсам.

      Обратите внимание на следующее:

      • Указанные вами пути к ресурсам применяются ко всем прокси-серверам API, добавленным к продукту API.
      • Более общие, менее специфичные пути к ресурсам имеют приоритет над более конкретными. Например, если вы добавите / и /** , приоритет будет иметь путь к ресурсу / ; путь к ресурсу /** будет проигнорирован.

      Например:

      

   4. Нажмите «Добавить» или «Добавить и запустить еще один» (чтобы указать дополнительные ресурсы API).
5. (Необязательно) Используйте раздел «Цели удаленных служб Apigee» , чтобы привязать продукт к одной или нескольким целям удаленных служб. Если вы не используете адаптер Apigee Envoy, вы можете игнорировать этот параметр. Для получения дополнительной информации см. руководство по эксплуатации адаптера Apigee Envoy.

6. (Необязательно) В разделе «Пользовательские атрибуты» можно добавить до 18 пользовательских атрибутов к продукту API.

   Пользовательские атрибуты представляют собой пары ключ/значение, которые можно использовать различными способами, в том числе для управления выполнением API-прокси. Например, вы можете создать пользовательский атрибут с именем deprecated и значением true или false. В потоке API-прокси вы можете проверить значение атрибута deprecated продукта API (например, используя переменную verifyapikey.{policy_name}.apiproduct.deprecated , которая автоматически становится доступной после создания пользовательского атрибута). Если его значение равно true (deprecated), вы можете сгенерировать ошибку с помощью политики Raise Fault.

7. Нажмите « Сохранить ».

Настройка поведения пути к ресурсу, содержащего '/', '/*' и '/**'.

В следующей таблице описано поведение API-продукта по умолчанию для различных путей к ресурсам . В этом примере базовый путь API-прокси — /v1/weatherapikey . Путь к ресурсам API-продукта применяется к суффиксу пути после базового пути.

По умолчанию путь к ресурсу / в API-продукте поддерживает базовый путь и все подпути. Например, если базовый путь API-прокси — /v1/weatherapikey , то API-продукт поддерживает запросы к /v1/weatherapikey и к любым подпутям, таким как /v1/weatherapikey/forecastrss , /v1/weatherapikey/region/CA и так далее.

Вы можете изменить это значение по умолчанию таким образом, чтобы путь к ресурсу / соответствовал только базовому пути API-прокси, то есть API-продукт не разрешит доступ к URI, содержащему что-либо после / . Если вы внесете это изменение, то в приведенной выше таблице только первые две строки в разделе «Разрешено для /» будут содержать «Y».

Чтобы изменить значение по умолчанию, системный администратор должен установить значение свойства features.isSingleForwardSlashBlockingEnabled в вашей организации равным true . Клиенты облачной версии могут отправить этот запрос в службу поддержки Apigee Edge .

Редактирование продукта API

Чтобы отредактировать продукт API:

1. Перейдите на страницу продуктов API , как описано ранее в этом разделе.
2. Щёлкните по строке продукта API, который хотите отредактировать.
3. На странице продукта API нажмите кнопку «Редактировать» .
4. При необходимости отредактируйте поля.

   Вы можете удалить ресурсы, добавленные в API-продукт. Это может потребоваться, если ресурс работает некорректно или требует доработки. После удаления ресурс больше не является частью API-продукта. Любое приложение, использующее API-продукт, больше не сможет получить доступ к удаленному ресурсу. Удаленные ресурсы удаляются из продукта, но не удаляются из системы, поэтому они по-прежнему могут использоваться другими продуктами.

5. Нажмите « Сохранить ».

В Apigee Edge для публичного облака Edge хранит следующие объекты в кэше как минимум 180 секунд после обращения к ним.

• Токены доступа OAuth. Это означает, что отозванный токен может оставаться активным в течение до трех минут, пока не истечет лимит его кэширования.
• Сущности службы управления ключами (KMS) (приложения, разработчики, API-продукты).
• Пользовательские атрибуты для токенов OAuth и сущностей KMS.

Удаление продукта API

Прежде чем удалить API-продукт, необходимо отменить регистрацию/отменить связь всех приложений разработчиков с этим продуктом. Это можно сделать либо удалив приложения , либо отозвав ключи API приложений .

Чтобы удалить продукт API:

1. Перейдите на страницу продуктов API , как описано ранее в этом разделе.
2. Наведите курсор на продукт API в списке.
3. Нажмите .
4. Нажмите «Удалить» , чтобы подтвердить операцию удаления.

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

Управление продуктами API осуществляется с помощью пользовательского интерфейса управления Apigee Edge, как описано в этом разделе. Для управления продуктами API с помощью самого API см. раздел «Использование API управления Edge для публикации API» .

Обзор продуктов API см. в разделе «Что такое продукт API?» .

Изучите страницу продуктов API.

Перейдите на страницу продуктов API, как описано ниже.

Добавление продукта API

Добавьте продукт API с помощью пользовательского интерфейса, как описано ниже. Чтобы использовать Edge API, см. раздел «Настройка продуктов API с помощью API» .

Чтобы добавить продукт API с помощью пользовательского интерфейса Edge:

1. Перейдите на страницу продуктов API , как описано ранее в этом разделе.
2. Нажмите +API Продукт .
3. Введите подробные сведения о вашем API-продукте.
   

   Поле	Описание
   Имя	Внутреннее имя продукта API. После создания продукта API изменить его нельзя. Не указывайте в имени специальные символы.
   Отображаемое имя	Отображаемое имя для продукта API. Отображаемое имя используется в пользовательском интерфейсе, и вы можете изменить его в любое время. Если не указано, будет использоваться значение «Имя». Это поле автоматически заполняется значением «Имя»; вы можете редактировать или удалять его содержимое. Отображаемое имя может содержать специальные символы.
   Описание	Описание продукта API.
   Среда	Среды, к которым API-продукт предоставит доступ. Например, test или prod .
   Доступ	Уровень доступа. Подробности см. в разделе «Уровень доступа» .
   Автоматическое одобрение запросов на доступ	Включите автоматическое подтверждение запросов ключей для этого API-продукта из любого приложения. Чтобы требовать ручного подтверждения ключей, отключите эту опцию. См. разделы «Регистрация приложений и управление ключами API (пользовательский интерфейс)» и «Ключи приложений разработчиков (API)».
   Квота	Ограничение квоты, на которое вы хотите ссылаться в политиках квот. Ввод значения квоты не приводит к автоматическому применению ограничений на количество вызовов, которые могут быть выполнены через продукт. API-прокси, на которые ссылается продукт, должны включать политику квот для обеспечения соблюдения квоты. Для получения дополнительной информации см. раздел «Квоты» .
   Разрешенные области действия OAuth	Если вы используете OAuth с API-продуктом, укажите разрешенные области действия OAuth, которые вы хотите разрешить API-продукту (например, Read или другие области действия, которые приложения будут отправлять со своими API-вызовами). Укажите несколько областей действия в виде списка, разделенного запятыми. См. раздел «Области действия OAuth» .

4. Добавьте ресурсы API , доступные в продукте API, включая прокси API и пути к ресурсам.

   Например, если вы добавите к продукту прокси-сервер API для доступа к музыке с базовым путем /music , продукт API разрешит вызовы к /music . Однако, если вы хотите, чтобы продукт API разрешал доступ только к ресурсу venues , URI которого равен /music/venues , добавьте ресурс /venues к продукту. В этом случае вызовы к /music/venues?name=paramount будут разрешены, но вызовы к /music/artists?name=Jack%Johnson будут заблокированы.

   Укажите конкретный путь к ресурсу или задайте базовый путь и все возможные подпути, указав путь к ресурсу как / . Путь к ресурсу может включать подстановочные знаки /** и /* . Подстановочный знак в виде двойной звездочки указывает на то, что поддерживаются все подпути базового пути (но не сам базовый путь). Одиночная звездочка указывает на то, что поддерживаются только URI на один уровень ниже базового пути. См. раздел «Настройка поведения пути к ресурсу для '/', '/*' и '/**'» , описанный далее в этом разделе.

   Для добавления ресурсов API:

   1. В разделе ресурсов API нажмите «Добавить прокси» или «Добавить путь» .
   2. Выберите, хотите ли вы добавить API-прокси , путь или и то, и другое : API-прокси и путь .

      

   3. Добавьте один или несколько API-прокси и путей к ресурсам.

      Обратите внимание на следующее:

      • Указанные вами пути к ресурсам применяются ко всем прокси-серверам API, добавленным к продукту API.
      • Более общие, менее специфичные пути к ресурсам имеют приоритет над более конкретными. Например, если вы добавите / и /** , приоритет будет иметь путь к ресурсу / ; путь к ресурсу /** будет проигнорирован.

      Например:

      

   4. Нажмите «Добавить» или «Добавить и запустить еще один» (чтобы указать дополнительные ресурсы API).
5. (Необязательно) Используйте раздел «Цели удаленных служб Apigee» , чтобы привязать продукт к одной или нескольким целям удаленных служб. Если вы не используете адаптер Apigee Envoy, вы можете игнорировать этот параметр. Для получения дополнительной информации см. руководство по эксплуатации адаптера Apigee Envoy.

6. (Необязательно) В разделе «Пользовательские атрибуты» можно добавить до 18 пользовательских атрибутов к продукту API.

   Пользовательские атрибуты представляют собой пары ключ/значение, которые можно использовать различными способами, в том числе для управления выполнением API-прокси. Например, вы можете создать пользовательский атрибут с именем deprecated и значением true или false. В потоке API-прокси вы можете проверить значение атрибута deprecated продукта API (например, используя переменную verifyapikey.{policy_name}.apiproduct.deprecated , которая автоматически становится доступной после создания пользовательского атрибута). Если его значение равно true (deprecated), вы можете сгенерировать ошибку с помощью политики Raise Fault.

7. Нажмите « Сохранить ».

Настройка поведения пути к ресурсу, содержащего '/', '/*' и '/**'.

В следующей таблице описано поведение API-продукта по умолчанию для различных путей к ресурсам . В этом примере базовый путь API-прокси — /v1/weatherapikey . Путь к ресурсам API-продукта применяется к суффиксу пути после базового пути.

По умолчанию путь к ресурсу / в API-продукте поддерживает базовый путь и все подпути. Например, если базовый путь API-прокси — /v1/weatherapikey , то API-продукт поддерживает запросы к /v1/weatherapikey и к любым подпутям, таким как /v1/weatherapikey/forecastrss , /v1/weatherapikey/region/CA и так далее.

Вы можете изменить это значение по умолчанию таким образом, чтобы путь к ресурсу / соответствовал только базовому пути API-прокси, то есть API-продукт не разрешит доступ к URI, содержащему что-либо после / . Если вы внесете это изменение, то в приведенной выше таблице только первые две строки в разделе «Разрешено для /» будут содержать «Y».

Чтобы изменить значение по умолчанию, системный администратор должен установить значение свойства features.isSingleForwardSlashBlockingEnabled в вашей организации равным true . Клиенты облачной версии могут отправить этот запрос в службу поддержки Apigee Edge .

Редактирование продукта API

Чтобы отредактировать продукт API:

1. Перейдите на страницу продуктов API , как описано ранее в этом разделе.
2. Щёлкните по строке продукта API, который хотите отредактировать.
3. На странице продукта API нажмите кнопку «Редактировать» .
4. При необходимости отредактируйте поля.

   Вы можете удалить ресурсы, добавленные в API-продукт. Это может потребоваться, если ресурс работает некорректно или требует доработки. После удаления ресурс больше не является частью API-продукта. Любое приложение, использующее API-продукт, больше не сможет получить доступ к удаленному ресурсу. Удаленные ресурсы удаляются из продукта, но не удаляются из системы, поэтому они по-прежнему могут использоваться другими продуктами.

5. Нажмите « Сохранить ».

В Apigee Edge для публичного облака Edge хранит следующие объекты в кэше как минимум 180 секунд после обращения к ним.

• Токены доступа OAuth. Это означает, что отозванный токен может оставаться активным в течение до трех минут, пока не истечет лимит его кэширования.
• Сущности службы управления ключами (KMS) (приложения, разработчики, API-продукты).
• Пользовательские атрибуты для токенов OAuth и сущностей KMS.

Удаление продукта API

Прежде чем удалить API-продукт, необходимо отменить регистрацию/отменить связь всех приложений разработчиков с этим продуктом. Это можно сделать либо удалив приложения , либо отозвав ключи API приложений .

Чтобы удалить продукт API:

1. Перейдите на страницу продуктов API , как описано ранее в этом разделе.
2. Наведите курсор на продукт API в списке.
3. Нажмите .
4. Нажмите «Удалить» , чтобы подтвердить операцию удаления.

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

Управление продуктами API осуществляется с помощью пользовательского интерфейса управления Apigee Edge, как описано в этом разделе. Для управления продуктами API с помощью самого API см. раздел «Использование API управления Edge для публикации API» .

Обзор продуктов API см. в разделе «Что такое продукт API?» .

Изучите страницу продуктов API.

Перейдите на страницу продуктов API, как описано ниже.

Добавление продукта API

Добавьте продукт API с помощью пользовательского интерфейса, как описано ниже. Чтобы использовать Edge API, см. раздел «Настройка продуктов API с помощью API» .

Чтобы добавить продукт API с помощью пользовательского интерфейса Edge:

1. Перейдите на страницу продуктов API , как описано ранее в этом разделе.
2. Нажмите +API Продукт .
3. Введите подробные сведения о вашем API-продукте.
   

   Поле	Описание
   Имя	Внутреннее имя продукта API. После создания продукта API изменить его нельзя. Не указывайте в имени специальные символы.
   Отображаемое имя	Отображаемое имя для продукта API. Отображаемое имя используется в пользовательском интерфейсе, и вы можете изменить его в любое время. Если не указано, будет использоваться значение «Имя». Это поле автоматически заполняется значением «Имя»; вы можете редактировать или удалять его содержимое. Отображаемое имя может содержать специальные символы.
   Описание	Описание продукта API.
   Среда	Среды, к которым API-продукт предоставит доступ. Например, test или prod .
   Доступ	Уровень доступа. Подробности см. в разделе «Уровень доступа» .
   Автоматическое одобрение запросов на доступ	Включите автоматическое подтверждение запросов ключей для этого API-продукта из любого приложения. Чтобы требовать ручного подтверждения ключей, отключите эту опцию. См. разделы «Регистрация приложений и управление ключами API (пользовательский интерфейс)» и «Ключи приложений разработчиков (API)».
   Квота	Ограничение квоты, на которое вы хотите ссылаться в политиках квот. Ввод значения квоты не приводит к автоматическому применению ограничений на количество вызовов, которые могут быть выполнены через продукт. API-прокси, на которые ссылается продукт, должны включать политику квот для обеспечения соблюдения квоты. Для получения дополнительной информации см. раздел «Квоты» .
   Разрешенные области действия OAuth	Если вы используете OAuth с API-продуктом, укажите разрешенные области действия OAuth, которые вы хотите разрешить API-продукту (например, Read или другие области действия, которые приложения будут отправлять со своими API-вызовами). Укажите несколько областей действия в виде списка, разделенного запятыми. См. раздел «Области действия OAuth» .

4. Добавьте ресурсы API , доступные в продукте API, включая прокси API и пути к ресурсам.

   Например, если вы добавите к продукту прокси-сервер API для доступа к музыке с базовым путем /music , продукт API разрешит вызовы к /music . Однако, если вы хотите, чтобы продукт API разрешал доступ только к ресурсу venues , URI которого равен /music/venues , добавьте ресурс /venues к продукту. В этом случае вызовы к /music/venues?name=paramount будут разрешены, но вызовы к /music/artists?name=Jack%Johnson будут заблокированы.

   Укажите конкретный путь к ресурсу или задайте базовый путь и все возможные подпути, указав путь к ресурсу как / . Путь к ресурсу может включать подстановочные знаки /** и /* . Подстановочный знак в виде двойной звездочки указывает на то, что поддерживаются все подпути базового пути (но не сам базовый путь). Одиночная звездочка указывает на то, что поддерживаются только URI на один уровень ниже базового пути. См. раздел «Настройка поведения пути к ресурсу для '/', '/*' и '/**'» , описанный далее в этом разделе.

   Для добавления ресурсов API:

   1. В разделе ресурсов API нажмите «Добавить прокси» или «Добавить путь» .
   2. Выберите, хотите ли вы добавить API-прокси , путь или и то, и другое : API-прокси и путь .

      

   3. Добавьте один или несколько API-прокси и путей к ресурсам.

      Обратите внимание на следующее:

      • Указанные вами пути к ресурсам применяются ко всем прокси-серверам API, добавленным к продукту API.
      • Более общие, менее специфичные пути к ресурсам имеют приоритет над более конкретными. Например, если вы добавите / и /** , приоритет будет иметь путь к ресурсу / ; путь к ресурсу /** будет проигнорирован.

      Например:

      

   4. Нажмите «Добавить» или «Добавить и запустить еще один» (чтобы указать дополнительные ресурсы API).
5. (Необязательно) Используйте раздел «Цели удаленных служб Apigee» , чтобы привязать продукт к одной или нескольким целям удаленных служб. Если вы не используете адаптер Apigee Envoy, вы можете игнорировать этот параметр. Для получения дополнительной информации см. руководство по эксплуатации адаптера Apigee Envoy.

6. (Необязательно) В разделе «Пользовательские атрибуты» можно добавить до 18 пользовательских атрибутов к продукту API.

   Пользовательские атрибуты представляют собой пары ключ/значение, которые можно использовать различными способами, в том числе для управления выполнением API-прокси. Например, вы можете создать пользовательский атрибут с именем deprecated и значением true или false. В потоке API-прокси вы можете проверить значение атрибута deprecated продукта API (например, используя переменную verifyapikey.{policy_name}.apiproduct.deprecated , которая автоматически становится доступной после создания пользовательского атрибута). Если его значение равно true (deprecated), вы можете сгенерировать ошибку с помощью политики Raise Fault.

7. Нажмите « Сохранить ».

Настройка поведения пути к ресурсу, содержащего '/', '/*' и '/**'.

В следующей таблице описано поведение API-продукта по умолчанию для различных путей к ресурсам . В этом примере базовый путь API-прокси — /v1/weatherapikey . Путь к ресурсам API-продукта применяется к суффиксу пути после базового пути.

По умолчанию путь к ресурсу / в API-продукте поддерживает базовый путь и все подпути. Например, если базовый путь API-прокси — /v1/weatherapikey , то API-продукт поддерживает запросы к /v1/weatherapikey и к любым подпутям, таким как /v1/weatherapikey/forecastrss , /v1/weatherapikey/region/CA и так далее.

Вы можете изменить это значение по умолчанию таким образом, чтобы путь к ресурсу / соответствовал только базовому пути API-прокси, то есть API-продукт не разрешит доступ к URI, содержащему что-либо после / . Если вы внесете это изменение, то в приведенной выше таблице только первые две строки в разделе «Разрешено для /» будут содержать «Y».

Чтобы изменить значение по умолчанию, системный администратор должен установить значение свойства features.isSingleForwardSlashBlockingEnabled в вашей организации равным true . Клиенты облачной версии могут отправить этот запрос в службу поддержки Apigee Edge .

Редактирование продукта API

Чтобы отредактировать продукт API:

1. Перейдите на страницу продуктов API , как описано ранее в этом разделе.
2. Щёлкните по строке продукта API, который хотите отредактировать.
3. На странице продукта API нажмите кнопку «Редактировать» .
4. Edit the fields, as required.

   You can delete resources that you've added to an API product. You might want to do this if a resource is malfunctioning or requires more development. When deleted, that resource is no longer part of the API product. Any app that uses the API product can no longer access the deleted resource. Deleted resources are removed from the product but are not deleted from the system, so they can still be used by other products.

5. Нажмите « Сохранить ».

With Apigee Edge for Public Cloud , Edge keeps the following entities in cache for a minimum of 180 seconds after the entities are accessed .

• OAuth access tokens. This means that a revoked token may still succeed for up to three minutes, until its cache limit expires.
• Key Management Service (KMS) entities (Apps, Developers, API Products).
• Custom attributes on OAuth tokens and KMS entities.

Deleting an API product

Before you can delete an API product, you must unregister/unassociate any developer apps associated with the product. You can do so by either deleting the apps or revoking the app API keys .

To delete an API product:

1. Access the API products page , as described previously in this section.
2. Position the cursor over the API product in the list.
3. Нажмите .
4. Нажмите «Удалить» , чтобы подтвердить операцию удаления.