Управление выплатами с помощью API службы выплат

В этой статье объясняется, как получить доступ к данным о выплатах с помощью API-интерфейсов службы выплат, а не пользовательского интерфейса Центра партнеров. Эти API предоставляют программный способ предоставления возможности функции экспорта данных в Центре партнеров.

Внимание

Azure Active Directory (Azure AD) Graph не рекомендуется использовать с 30 июня 2023 г. Идти вперед, мы не делаем дальнейших инвестиций в Azure AD Graph. API Azure AD Graph не имеют соглашения об уровне обслуживания или обслуживании за пределами исправлений, связанных с безопасностью. Инвестиции в новые функции и функциональные возможности будут сделаны только в Microsoft Graph.

Мы отставим Azure AD Graph на добавочных шагах, чтобы у вас было достаточно времени для переноса приложений в API Microsoft Graph. На более позднюю дату, которую мы объявим, мы заблокируем создание новых приложений с помощью Azure AD Graph.

Дополнительные сведения см. в статье "Важно: выход на пенсию в Azure AD Graph и отключение модуля PowerShell".

Доступные интерфейсы API

Ознакомьтесь со всеми доступными API-интерфейсами в партнерских выплатах.

Необходимые компоненты

• Зарегистрируйте приложение с помощью Microsoft Identity в портал Azure и добавьте в приложение соответствующих владельцев и ролей.
• Установить Visual Studio.

Регистрация приложения с помощью платформы удостоверений Майкрософт

Платформа удостоверений Майкрософт помогает создавать приложения, которые пользователи и клиенты могут входить в систему с помощью удостоверений Майкрософт или социальных учетных записей, а также предоставлять авторизованный доступ к собственным API или API Майкрософт, таким как Microsoft Graph.

1. Войдите на портал Azure с помощью личной учетной записи Майкрософт либо рабочей или учебной учетной записи.

   Если ваша учетная запись предоставляет доступ к нескольким клиентам, выберите свою учетную запись в правом верхнем углу и задайте для сеанса портала правильный клиент Microsoft Entra.

2. В области навигации слева выберите службу Microsoft Entra, а затем Регистрация приложений, а затем новую регистрацию. Появится страница Регистрация приложения.

3. Введите сведения о регистрации приложения:

   • Имя. Введите понятное имя приложения, которое будет отображаться пользователям приложения.
   • Поддерживаемые типы учетных записей: выберите учетные записи, которые будут поддерживать приложение.

   Поддерживаемые типы учетных записей	Description
   Только учетные записи в этом каталоге организации	Этот вариант подходит для создания бизнес-приложений. Он будет недоступен, если приложение не регистрируется в каталоге. Этот параметр сопоставляется только с одним клиентом Microsoft Entra. Этот параметр используется по умолчанию, если только приложение не регистрируется за пределами каталога. В случаях, когда приложение зарегистрировано за пределами каталога, по умолчанию используется мультитенантная и личная учетная запись Майкрософт.
   Учетные записи в любом каталоге организации	Выберите этот параметр, если вы хотите выбрать в качестве целевой аудитории предприятия и учебные заведения. Этот параметр сопоставляется с мультитенантом только для Microsoft Entra. Если вы зарегистрировали приложение в качестве одного клиента только для Microsoft Entra, его можно обновить, чтобы он был мультитенантным и обратно в один клиент с помощью колонки проверки подлинности.
   Учетные записи в любом организационном каталоге и личные учетные записи Майкрософт	Этот параметр предназначен для самого широкого набора клиентов. Этот параметр сопоставляется с мультитенантными и личными учетными записями Майкрософт в Microsoft Entra. Если вы зарегистрировали приложение в качестве мультитенантных и личных учетных записей Майкрософт, вы не можете изменить этот выбор в пользовательском интерфейсе. Вместо этого необходимо изменить поддерживаемые типы учетных записей с помощью редактора манифестов приложений.

   • (необязательно) Универсальный код ресурса (URI перенаправления): выберите тип создаваемого приложения, веб-клиента или общедоступного клиента (мобильного и рабочего стола), а затем введите URI перенаправления (или URL-адрес ответа) для приложения. (URL-адрес перенаправления — это место, в котором будет отправлен ответ проверки подлинности после проверки подлинности пользователя.)

     Для веб-приложений укажите основной URL-адрес приложения. Например, выполняемое на локальном компьютере веб-приложение может иметь адрес http://localhost:31544. Пользователи будут использовать этот URL-адрес для входа в приложение веб-клиента. Для общедоступных клиентских приложений укажите универсальный код ресурса (URI), используемый идентификатором Microsoft Entra для возврата ответов маркеров. Укажите значение, специфичное для вашего приложения, например myapp://auth.

4. Выберите Зарегистрировать. Идентификатор Microsoft Entra назначает уникальный идентификатор приложения (клиента) приложению, а страница обзора приложения загружается.

5. Если вы хотите добавить возможности в приложение, можно выбрать другие параметры конфигурации, включая фирменные символики, сертификаты и секреты, разрешения API и многое другое.

Свойства для конкретной платформы

В следующей таблице показаны свойства, которые необходимо настроить и скопировать для различных типов приложений. Назначено означает, что следует использовать значение, назначенное идентификатором Microsoft Entra.

Тип приложения	Платформа	Идентификатор приложения (клиент)	Секрет клиента	URI/URL-адрес перенаправления	Неявный поток
Собственные и мобильные устройства	Нативный	Назначенные	No	Назначенные	No
Веб-приложение	Интернет	Назначенные	Да	Да	Необязательный ПО промежуточного слоя OpenID Connect использует гибридный поток по умолчанию (да)
Одностраничные приложения (SPA)	Интернет	Назначенные	Да	Да	Да SPAs используют неявный поток OpenID Connect
Служба или управляющая программа	Интернет	Назначенные	Да	Да	Нет

Создание субъекта-службы

Чтобы обеспечить доступ к ресурсам в подписке, необходимо назначить роль для приложения. Сведения о том, какая роль предлагает правильные разрешения для приложения, см. в статье о встроенных ролях Azure.

Примечание.

Вы можете задать область действия на уровне подписки, группы ресурсов или ресурса. Разрешения наследуют более низкие уровни области действия. Например, добавление приложения в роль Читатель для группы ресурсов означает, что оно может использоваться для чтения группы ресурсов и любых содержащихся в ней ресурсов.

1. В портал Azure выберите уровень области, назначаемой приложению. Например, чтобы назначить роль в области подписки, найдите и выберите подписки или выберите подписки на домашней странице.

   

2. Выберите подписку, для которой хотите назначить приложение.

   

   Примечание.

   Если вы не видите нужную подписку, выберите фильтр глобальных подписок и убедитесь, что для портала выбрана нужная подписка.

3. Выберите Управление доступом (IAM), а затем Добавление назначения ролей.

4. Выберите роль, которая будет назначена приложению. Например, чтобы разрешить приложению выполнять такие действия, как перезагрузка, запуск и остановка экземпляров, выберите роль Участник. Дополнительные сведения о доступных ролях.

   По умолчанию приложения Microsoft Entra не отображаются в доступных параметрах. Чтобы найти приложение, выполните поиск по имени и выберите его из результатов. На снимке экрана example-app ниже приведено зарегистрировано приложение Microsoft Entra.

5. Выберите Сохранить. Затем приложение можно увидеть в списке пользователей с ролью для этой области.

   Вы можете начать использовать субъект-службу для запуска скриптов или приложений. Чтобы управлять разрешениями субъекта-службы, просмотрите состояние согласия пользователя, просмотрите разрешения, см. сведения о входе и многое другое), просмотрите корпоративные приложения в портал Azure.

Настройка разрешений API

В этом разделе содержатся инструкции по настройке необходимых разрешений API. Дополнительные сведения о настройке разрешений API Центра партнеров см. в разделе "Проверка подлинности API партнера".

Предоставление разрешения API Graph

1. Откройте Регистрация приложений в портал Azure.

2. Выберите приложение или создайте приложение , если у вас еще нет приложения.

3. На странице обзора приложения в разделе "Управление" выберите "Разрешения API", а затем добавьте разрешение.

4. Выберите Microsoft Graph в списке доступных интерфейсов API.

5. Выберите делегированные разрешения и добавьте необходимые разрешения. Дополнительные сведения см. в разделе "Настройка доступа к приложению".

   

   Согласие на доступ к API Центра партнеров через приложение Microsoft Entra

6. Для приложения выберите разрешения API, а затем на экране разрешений API запроса выберите пункт "Добавить разрешение", а затем API, которые используются в моей организации.

7. Поиск API партнера Майкрософт (Microsoft Центр разработки) (4990cffe-04e8-4e8b-808a-1175604b879f).

   

8. Задайте делегированные разрешения в Центре партнеров.

   

9. Предоставьте согласие администратора для API.

   

   Убедитесь, что согласие администратора включено на экране состояния согласия администратора.

   

10. В разделе "Проверка подлинности" убедитесь, что параметр "Разрешить общедоступные потоки клиентов" имеет значение "Да".

Запуск примера кода в Visual Studio

Пример кода, показывающий, как API можно использовать для журнала платежей и транзакций, можно найти в репозитории GitHub для api-интерфейсов Partner-Center-Payout-API.

Примеры заметок кода

• Настройка секретов и сертификатов клиента, как описано в разделе "Проверка подлинности": два раздела "Создание субъекта-службы" в портал Azure не требуется.
• Учетные записи с многофакторной проверкой подлинности (MFA) в настоящее время не поддерживаются и вызывают ошибку.
• API выплат поддерживает только учетные данные на основе паролей и пользователей.

Связанный контент

• Создание приложения Microsoft Entra и субъекта-службы с доступом к ресурсам с помощью портала
• Краткое руководство: регистрация приложения с помощью платформы удостоверений Майкрософт (предварительная версия)
• Настройка клиентского приложения для доступа к веб-API