Группы API

Создание группы

  1. Выберите Application → API Gateway.

  2. Далее выберите API Publishing → API Groups.

  3. Нажмите кнопку Create API Group.

    ../_images/s__push-button-create-api-group.jpeg
  4. Заполните следующие поля и нажмите кнопку ОК:

    1. Name — укажите имя группы.

    2. Description — введите описание.

  5. В новом окне нажмите кнопку ОК.

Прикрепление доменного имени к группе

Прежде чем опубликовать API, к принадлежащей ему группе нужно прикрепить один или несколько внешних доменов (до 5). Если доменные имена не привязаны к группе, то API будет вызываться с использованием имени поддомена и количество вызовов будет ограничено 1000 в день.

  1. Выберите Application → API Gateway.

  2. Далее выберите API Publishing → API Groups.

  3. В строке с нужной группой нажмите More и выберите из списка Manage Domain Name.

    ../_images/s__menu-more-managedomainname.jpeg
  4. Нажмите Bind Domain Name.

    Внимание

    В доменном имени должна быть CNAME-запись с именем поддомена группы API (скопируйте имя в API Group → вкладка Summary > скопируйте имя в поле Subdomain Name).

  5. Введите в поле доменное имя в формате www.example.com и нажмите значок Кнопка с галочкой.

  6. После успешного добавления доменного имени появится новая запись.

Прикрепление SSL сертификата

  1. Выберите Application → API Gateway.

  2. Далее выберите API Publishing → API Groups.

  3. В строке с нужной группой нажмите More и выберите из списка Manage Domain Name.

    ../_images/s__menu-more-managedomainname.jpeg
  4. В строке с нужным доменом нажмите Add SSL Certificate.

  5. Заполните поля и нажмите кнопку ОК:

    1. Certificate Name — укажите имя сертификата.

    2. Certificate Content — введите запрос (публичный ключ) вашего сертификата.

    3. Private Key — введите приватный ключ вашего сертификата.

    ../_images/s__add-ssl-sertificate.jpeg

Ответ шлюза

Добавление ответа шлюза

  1. Выберите Application → API Gateway.

  2. Далее выберите API Publishing → API Groups.

  3. Нажмите на имя нужной группы.

  4. Перейдите на вкладку Gateway Responses и нажмите кнопку Create Gateway Response.

    ../_images/s__create-gateway-responce.jpeg
  5. В поле Name укажите имя отклика и нажмите кнопку ОК.

  6. Сделайте следующее:

    1. Нажмите на имя нового отклика.

    2. Выберите в списке нужный тип отклика.

    3. Нажмите кнопку Edit.

    4. Укажите нужный код ответа (поле Status Code) и введите в редактор сообщение об ошибке.

    5. После произведенных изменений нажмите кнопку ОК (появляется в режиме редактирования отклика).

../_images/s__response-details.jpeg

Изменение ответа шлюза

  1. Выберите Application → API Gateway.

  2. Далее выберите API Publishing → API Groups.

  3. Нажмите на имя нужной группы.

  4. Перейдите на вкладку Gateway Responses, выберите нужный отклик и тип отклика. Нажмите кнопку Edit.

  5. Сделайте следующее и нажмите кнопку ОК:

    1. В поле Status Code укажите нужный код ответа.

    2. Введите в редактор сообщение об ошибке.

    ../_images/s__enter-error-massage.jpeg

Удаление ответа шлюза

  1. Выберите Application → API Gateway.

  2. Далее выберите API Publishing → API Groups.

  3. Нажмите на имя нужной группы.

  4. Перейдите на вкладку Gateway Responses, наведите курсор на строку нужного отклика, нажмите на значок Кнопка меню-кебаб и выберите из списка Delete.

    ../_images/s__del-gateway-response.jpeg
  5. Нажмите кнопку ОК.

Удаление группы

  1. Выберите Application → API Gateway.

  2. Далее выберите API Publishing → API Groups.

  3. В строке с нужной группой нажмите More и выберите из списка Delete.

  4. Введите в поле слово «DELETE» и нажмите кнопку Yes.

Примечание

Удалить можно только группу, к которой не привязан API. Сначала удалите API, затем — группу.