Справочные материалы по API портала Cloud Partner
Примечание.
Программные интерфейсы портала Cloud Partner интегрированы с Центром партнеров, они продолжат в нем работу. Переход повлечет за собой небольшие изменения. Ознакомьтесь со списком изменений в API Портала Cloud Partner в этом документе и убедитесь, что ваш код будет нормально работать после перехода в Центр партнеров. Программные интерфейсы CPP следует использовать только для существующих продуктов, которые уже были интегрированы, до перехода в Центр партнеров; новые продукты должны использовать программные интерфейсы отправки Центра партнеров.
REST API портала Cloud Partner позволяют осуществлять программный поиск и обработку рабочих нагрузок, предложений и профилей издателей. API используют управление доступом на основе ролей Azure (Azure RBAC) для обеспечения правильных разрешений во время обработки.
Эта ссылка предоставляет технические сведения для REST API портала Cloud Partner. Примеры полезных данных в этом документе, предназначены только для справки и могут меняться по мере добавления новых функциональных возможностей.
Предварительные требования и рекомендации
Прежде чем использовать API-интерфейсы, следует проверить следующее:
- В статье "Предварительные требования" , чтобы узнать, как добавить субъект-службу в учетную запись и получить маркер доступа Microsoft Entra для проверки подлинности.
- две стратегии управления параллелизмом, доступные для вызова этих API;
- Другие рекомендации по API, такие как управление версиями и обработка ошибок.
Изменения в API Портала Cloud Partner после миграции в Центр партнеров
| API | Описание изменения | Воздействие |
|---|---|---|
| POST Publish, GoLive, Cancel | Для перенесенных предложений заголовок ответа имеет другой формат, но продолжает работать таким же образом, обозначая относительный путь для получения состояния операции. | При отправке любого из соответствующих запросов POST для предложения заголовок Location имеет один из двух форматов в зависимости от состояния миграции предложения:
|
| Операция GET | Для типов предложений, которые ранее поддерживали в ответе поле notification-email, это поле объявляется устаревшим и не будет возвращаться для перенесенных предложений. | Для перенесенных предложений мы больше не будем отправлять уведомления на списки адресов электронной почты, указанные в запросах. Вместо этого служба API соответствует процессу электронной почты уведомлений в Центре партнеров для отправки сообщений электронной почты. В частности, уведомления о ходе выполнения операции будут отправляться по адресу электронной почты, указанному в разделе "Контактные данные продавца" параметров учетной записи в Центре партнеров. Просмотрите адрес электронной почты, заданный в разделе "Контактные данные продавца" параметров учетной записи в Центре партнеров, чтобы убедиться, что для уведомлений предоставлен правильный адрес электронной почты. |
Стандартные задачи
В этой статье содержатся сведения о API, для выполнения следующих задач.
Предложения
- Получение всех предложений
- Получение определенного предложения
- Получение состояния предложения
- Создание предложения
- Публикация предложения
Операции
Публикация приложения
Другие задачи
Устранение неполадок
Версии и обновления API
| Обновить | Что изменилось? |
|---|---|
| 12-2022 | Общедоступный API CPP (версия 2017-10-31) теперь обновляется для записи clientId и clientSecret для соединителя Marketo при настройке потенциальных клиентов. Во время настройки свинца не требуется предоставлять поле serverId вперед. Это обновление API не включает никаких обновлений версий или критических изменений. |