Рекомендации по API

Управление версиями API

Примечание.

Программные интерфейсы портала Cloud Partner интегрированы с Центром партнеров, они продолжат в нем работу. Переход повлечет за собой небольшие изменения. Ознакомьтесь с изменениями, описанными в статье Справочные материалы по API Портала Cloud Partner, чтобы убедиться, что ваш код продолжит работать после перехода в Центр партнеров. Программные интерфейсы CPP следует использовать только для существующих продуктов, которые уже были интегрированы, до перехода в Центр партнеров; новые продукты должны использовать программные интерфейсы отправки Центра партнеров.

Одновременно можно использовать несколько версий API. Клиентам необходимо указать, какую версию, они будут использовать, предоставляя параметр api-version как часть строки запроса.

GET https://cloudpartner.azure.com/api/offerTypes?api-version=2017-10-31

Ошибка HTTP с кодом 400 — это ответ на запрос неизвестной или недопустимой версии API. Эта ошибка возвращает коллекцию известных версий API в текст ответа.

    {
        "error": { 
            "code":"InvalidAPIVersion",
            "message":"Invalid api version. Allowed values are [2016-08-01-preview]"
        }
    }

ошибки

API отвечает на ошибки с соответствующими кодами состояния HTTP и, необязательно, с дополнительной информацией в ответе, сериализованном как JSON. При получении ошибки, особенно класса 400, не повторяйте запрос не исправив основную проблему. Например в ответе примера выше, перед повторной отправкой запроса, исправьте параметр версии API.

Заголовок авторизации

Для всех API в этой ссылке необходимо передать заголовок авторизации вместе с маркером носителя, полученным из идентификатора Microsoft Entra. Этот заголовок необходим для получения допустимого ответа, если он отсутствует, ошибка 401 Unauthorized возвращается.

  GET https://cloudpartner.azure.com/api/offerTypes?api-version=2016-08-01-preview

    Accept: application/json 
    Authorization: Bearer <YOUR_TOKEN>