Вызов API

API можно вызвать 1,000 раз, используя отладочный домен, выделенный при создании группы API.

Получите информацию о вызове API у поставщика API перед тем, как вызвать API.

• Запрос

  В консоли APIG выберите API Publishing > APIs. Нажмите имя API, чтобы просмотреть доменное имя, метод запроса, путь запроса и базовую информацию об API.

• Аутентификация API

  Получите информацию об аутентификации запроса в соответствии с режимом аутентификации API.

  Режим аутентификации	Информация об аутентификации
  App (signature)	Получите AppKey и AppSecret приложения, авторизованного для API, у поставщика API, а также SDK для подписи.
  App (simple authentication)	Получите AppCode приложения, уполномоченного для API, у поставщика API.
  IAM (token)	Получите имя пользователя и пароль для облачной платформы.
  IAM (AK/SK)	Получите AK/SK учетной записи для облачной платформы и SDK подписи.
  Custom	Получите пользовательскую информацию аутентификации для передачи в параметрах запроса у поставщика API.
  None	Не требуется информация аутентификации.

  • AppKey и AppSecret приложения

    В консоли shared gateway выберите API Calling > Apps. В списке приложений нажмите имя приложения, которому предоставлен доступ API. На отображаемой странице сведений о приложении получите AppKey и AppSecret приложения.

  • SDK, используемый для подписей аутентификации

    В консоли shared gateway выберите Help Center > SDK Process Flow и загрузите SDK нужного языка.

  • AppCode

    В консоли shared gateway выберите API Calling > Apps. В списке приложений нажмите имя приложения, которому предоставлен доступ API. На отображаемой странице сведений о приложении получите AppCode на вкладке AppCodes.

1. Сформируйте запрос API. Пример:

    POST  https:// {Address} / {Path} ? {Query} 
    {Header} 
   
   {
      {Body} 
   }
   
   

   • POST: метод запроса. Замените его методом запроса, полученным в Obtaining API Calling Information.
   • {Address}: адрес запроса. Замените его доменным именем, полученным в Obtaining API Calling Information.

     Сценарий	Настройка параметров запроса
     Вызов API с доменным именем	Вызовите API, используя отладочное доменное имя, выделенное группе API, или доменное имя, привязанное к группе. Дополнительная настройка не требуется.
     Вызов API с IP-адресом	Чтобы использовать IP-адрес для вызова API, добавьте заголовочный параметр host.

   • {Path}: путь запроса. Замените его путем запроса, полученным в Obtaining API Calling Information.
   • {Query}: (optional) строка запроса в формате "Parameter_name=Parameter_value", например, limit=10. Разделяйте несколько строк запроса амперсандом (\u0026). Подробности см. в параметрах запроса, полученных в Obtaining API Calling Information.
   • {Header}: параметр заголовка запроса в формате "Parameter_name:Parameter_value", например, Content-Type:application/json. Подробности см. в параметрах запроса, полученных в Obtaining API Calling Information.
   • {Body}: тело запроса в формате JSON. Подробности см. в описании тела запроса, полученном в Obtaining API Calling Information.

2. Добавьте информацию об аутентификации в запрос API.

   Authentication Mode	Request Parameter Configuration
   App (signature)	Используйте полученный SDK для подписи запроса API. Для получения подробной информации см. раздел "Calling APIs Through App Authentication" в API Gateway Developer Guide.
   App (simple authentication)	Добавьте заголовочный параметр X-Apig-AppCode и установите значение параметра равным AppCode, полученному в Obtaining API Calling Information. Для получения подробной информации см. Getting Started.
   IAM (token)	Получите токен от облачной платформы и добавьте заголовочный параметр X-Auth-Token со значением токена. Для получения подробной информации см. раздел "Token Authentication" в API Gateway Developer Guide.
   IAM (AK/SK)	Используйте полученный SDK для подписи запроса API. Для получения подробной информации см. раздел "AK/SK Authentication" в API Gateway Developer Guide.
   Custom	Добавьте информацию, необходимую для пользовательской аутентификации, в запрос API.
   None	Вызовите API без аутентификации.