Управление выплатами с помощью API службы выплат
В этой статье объясняется, как получить доступ к данным о выплатах с помощью API-интерфейсов службы выплат, а не пользовательского интерфейса Центра партнеров. Эти API предоставляют программный способ предоставления возможности функции экспорта данных в Центре партнеров.
Внимание
Azure Active Directory (Azure AD) Graph не рекомендуется использовать с 30 июня 2023 г. В дальнейшем мы не будем вкладывать в Azure AD Graph. API Azure AD Graph не имеют соглашения об уровне предоставления услуг или обязательств по обслуживанию, кроме исправлений, связанных с безопасностью. Инвестиции в новые функции и функциональные возможности будут сделаны только в Microsoft Graph.
Мы будем постепенно выводить из эксплуатации Azure AD Graph, чтобы у вас было достаточно времени для переноса ваших приложений на Microsoft Graph API. На более позднюю дату, которую мы объявим, мы заблокируем создание новых приложений с помощью Azure AD Graph.
Дополнительные сведения см. в статье "Важно: вывод из эксплуатации Azure AD Graph и отключение модуля PowerShell".
Доступные интерфейсы API
Ознакомьтесь со всеми доступными API-интерфейсами в партнерских выплатах.
Предварительные условия
- Зарегистрируйте приложение с помощью Microsoft Identity в портал Azure и добавьте в приложение соответствующих владельцев и ролей.
- Установить Visual Studio.
Регистрация приложения в платформе идентификации Microsoft
Платформа удостоверений Майкрософт помогает создавать приложения, которые пользователи и клиенты могут входить в систему с помощью удостоверений Майкрософт или социальных учетных записей, а также предоставлять авторизованный доступ к собственным API или API Майкрософт, таким как Microsoft Graph.
Войдите на портал Azure с помощью личной учетной записи Майкрософт либо рабочей или учебной учетной записи.
Если ваша учетная запись предоставляет доступ к нескольким клиентам, выберите свою учетную запись в правом верхнем углу и задайте для сеанса портала правильный клиент Microsoft Entra.
В области навигации слева выберите службу Microsoft Entra, а затем Регистрация приложений, а затем новую регистрацию. Появится страница Регистрация приложения.
Введите сведения о регистрации приложения:
- Имя. Введите понятное имя приложения, которое будет отображаться пользователям приложения.
- Поддерживаемые типы учетных записей: выберите учетные записи, которые будут поддерживать приложение.
Поддерживаемые типы учетных записей Description Только аккаунты в этом организационном каталоге Выберите этот вариант, если вы разрабатываете корпоративное приложение (LOB). Он будет недоступен, если приложение не регистрируется в каталоге. Этот параметр сопоставляется только с одним клиентом Microsoft Entra. Этот параметр используется по умолчанию, если только приложение не регистрируется за пределами каталога. В случаях, когда приложение зарегистрировано за пределами каталога, по умолчанию используются учетные записи Microsoft Entra multitenant и личные учетные записи Microsoft. Учетные записи в любом каталоге организации Выберите этот параметр, если вы хотите выбрать в качестве целевой аудитории предприятия и учебные заведения. Этот параметр соответствует многопользовательской системе, предназначенной исключительно для Microsoft Entra. Если вы зарегистрировали приложение как одноклиентское приложение Microsoft Entra, вы можете обновить его, чтобы оно стало многоклиентским, и вернуть обратно в одноклиентское приложение, обновив настройки в панели аутентификации. Учетные записи в любом организационном каталоге и личные учетные записи Майкрософт Этот параметр предназначен для самого широкого набора клиентов. Этот параметр сопоставляется с мультитенантными и личными учетными записями Майкрософт в службе Microsoft Entra. Если вы зарегистрировали приложение как Microsoft Entra multitenant и личные учетные записи Microsoft, вы не можете изменить этот выбор в интерфейсе пользователя. Вместо этого необходимо изменить поддерживаемые типы учетных записей с помощью редактора манифестов приложений. (необязательно) URI перенаправления: выберите тип создаваемого приложения, веб-приложение или публичный клиент (мобильного и настольного устройства), а затем введите URI перенаправления для вашего приложения. (URL-адрес перенаправления — это место, куда будет отправлен ответ аутентификации после аутентификации пользователя.)
Для веб-приложений укажите основной URL-адрес приложения. Например, выполняемое на локальном компьютере веб-приложение может иметь адрес
http://localhost:31544. Пользователи будут использовать этот URL-адрес для входа в приложение веб-клиента. Для общедоступных клиентских приложений укажите URI, который используется Microsoft Entra ID для возврата токенов. Укажите значение, специфичное для вашего приложения, напримерmyapp://auth.
Выберите Зарегистрировать. Microsoft Entra ID присваивает уникальный идентификатор приложения (клиента) вашему приложению, и страница обзора приложения загружается.
Если вы хотите добавить возможности в приложение, можно выбрать другие параметры конфигурации, включая фирменные символики, сертификаты и секреты, разрешения API и многое другое.
Создание субъекта-службы
Чтобы обеспечить доступ к ресурсам в подписке, необходимо назначить роль для приложения. Сведения о том, какая роль предлагает правильные разрешения для приложения, см. в статье о встроенных ролях Azure.
Примечание.
Вы можете задать область действия на уровне подписки, группы ресурсов или ресурса. Разрешения наследуются на более низких уровнях области. Например, добавление приложения в роль Читатель для группы ресурсов означает, что оно может использоваться для чтения группы ресурсов и любых содержащихся в ней ресурсов.
На портале Azure выберите уровень области, который будет назначен приложению. Например, чтобы назначить роль в области подписки, найдите и выберите подписки или выберите подписки на домашней странице.
Выберите подписку, которой вы хотите присвоить приложение.
Примечание.
Если вы не видите нужную подписку, выберите фильтр глобальных подписок и убедитесь, что для портала выбрана нужная подписка.
Выберите Управление доступом (IAM), а затем Добавление назначения ролей.
Выберите роль, которую вы хотите назначить приложению. Например, чтобы разрешить приложению выполнять такие действия, как перезагрузка, остановка и запуск экземпляров, выберите роль «Contributor». Дополнительные сведения о доступных ролях.
По умолчанию приложения Microsoft Entra не отображаются в доступных параметрах. Чтобы найти приложение, выполните поиск по имени и выберите его из результатов. На приведенном ниже снимке экрана
example-app— это зарегистрированное приложение Microsoft Entra.Выберите Сохранить. Затем вы можете увидеть своё приложение в списке пользователей, имеющих роль в данной области.
Вы можете начать использовать служебный принципал для запуска скриптов или приложений. Чтобы управлять разрешениями служебного субъекта, просматривать состояние пользовательского согласия, проверять разрешения, видеть информацию о входе и многое другое, просмотрите корпоративные приложения в Портале Azure.
Настройка разрешений API
В этом разделе содержатся инструкции по настройке необходимых разрешений API. Дополнительные сведения о настройке разрешений API Центра партнеров см. в разделе "Проверка подлинности API партнера".
Предоставление разрешения API Graph
Откройте зарегистрированные приложения в портале Azure.
Выберите приложение или создайте приложение , если у вас еще нет приложения.
На странице обзора приложения в разделе "Управление" выберите "Разрешения API", а затем добавьте разрешение.
Выберите Microsoft Graph в списке доступных интерфейсов API.
Выберите делегированные разрешения и добавьте необходимые разрешения. Дополнительные сведения см. в разделе "Настройка доступа к приложению".
Согласие на доступ к API Центра партнеров через приложение Microsoft Entra
Для приложения выберите разрешения API, а затем на экране разрешений API запроса выберите пункт "Добавить разрешение", а затем API, которые используются в моей организации.
Поиск API партнера Майкрософт (Microsoft Центр разработки) (4990cffe-04e8-4e8b-808a-1175604b879f).
Задайте делегированные разрешения в Центре партнеров.
Предоставьте согласие администратора для API.
Убедитесь, что согласие администратора включено на экране состояния согласия администратора.
В разделе "Проверка подлинности" убедитесь, что параметр "Разрешить общедоступные потоки клиентов" имеет значение "Да".
Запуск примера кода в Visual Studio
Пример кода, показывающего, как API можно использовать для обработки платежей и истории транзакций, можно найти в репозитории GitHub Partner-Center-Payout-APIs.
Примеры заметок кода
- Настройка клиентских секретов и сертификатов, как обсуждается в разделе "Проверка подлинности: два варианта" из "Как создать принципала службы в портале Azure", не требуется.
- Учетные записи с многофакторной проверкой подлинности (MFA) в настоящее время не поддерживаются и вызывают ошибку.
- API выплат поддерживает только учетные данные пользователей на основе пароля.