Создание передачи для новой коммерции с помощью REST API Центра партнеров
Партнеры могут передавать новые коммерческие подписки от одного партнера по транзакциям другому. Целевой партнер создает запрос на передачу. Исходный партнер обновляет передачу с подробными сведениями о строке. В этом разделе объясняется, как API, целевой партнер вызовет создание запроса на передачу. Этот раздел относится только к резервированиям плана Azure, планам экономии и подпискам и новым подпискам на основе коммерческих лицензий. Более ценную информацию можно найти в документации по передаче подписок.
Необходимые компоненты
Учетные данные, описанные в статье о проверке подлинности в Центре партнеров. Этот сценарий поддерживает проверку подлинности с помощью автономных учетных данных приложения и приложения и пользователя.
Идентификатор клиента (
customer-tenant-ID
). Если вы не знаете идентификатор клиента, его можно найти в Центре партнеров, выбрав рабочую область "Клиенты" , затем клиент из списка клиентов, а затем учетная запись. На странице учетной записи клиента найдите Идентификатор Майкрософт в разделе Сведения об учетной записи клиента. Идентификатор Майкрософт совпадает с идентификатором клиента (customer-tenant-ID
).Соответствующие роли: агент по администрированию
Запрос REST
Синтаксис запроса
Способ | URI запроса |
---|---|
POST | {baseURL}/v1/customers/{customer-ID}/transfer HTTP/1.1 |
Параметр универсального кода ресурса
Используйте приведенный ниже параметр пути, чтобы определить клиента.
Имя. | Type | Обязательно | Описание |
---|---|---|---|
customer-id | строка | Да | Идентификатор guid, отформатированный идентификатором клиента, идентифицирующий клиента. |
Заголовки запросов
Дополнительные сведения см. в статье о заголовках REST Центра партнеров.
Текст запроса
В этой таблице описываются свойства TransferEntity в тексте запроса для создания нового запроса на передачу коммерции.
Свойство | Тип | Обязательно | Описание |
---|---|---|---|
sourcePartnerTenantId | строка | Да | Идентификатор guid отформатированного партнера, который определяет партнера, инициирующего передачу. |
sourcePartnerName | строка | Да | Имя организации партнера, инициирующей передачу. |
customerEmailId | строка | Да | Строка клиента для получения уведомлений о создании передачи. |
customerName | строка | Нет | Необязательно. Имя клиента, подписки которого передаются. |
targetPartnerTenantId | строка | Нет | Идентификатор отформатированного партнера GUID, определяющий партнера, которому предназначен перенос. Контекст авторизации партнера разрешает идентификатор клиента партнера, если опущен. |
targetPartnerEmailId | строка | Нет | Идентификатор отформатированного партнера GUID, определяющий партнера, которому предназначен перенос. Контекст авторизации партнера разрешает идентификатор клиента партнера, если опущен. |
transferType | строка | Да | Строка, определяющая тип передачи. 3 представляет New Commerce и должен использоваться для планов Azure и новых подписок на основе коммерческой лицензии. |
Пример запроса
{
"id": "43fb1d3a-79fe-45a9-863e-9a4acf17b630",
"status": "InProgress",
"transferType": 3,
"customerEmailId": "",
"createdTime": "2024-04-30T18:31:41.5133355Z",
"lastModifiedTime": "2024-05-01T00:51:55Z",
"expirationTime": "2024-05-31T00:00:00Z",
"customerName": "ipdbtrans2",
"customerTenantId": "a624f7f8-408b-49d0-9320-df79e56bed55",
"partnertenantid": "a94dcde1-ecd7-wace-a6ef-ef73ba6b8ba5",
"sourcePartnerName": "Test_Test_IP4_AG",
"sourcePartnerTenantId": "a94dcde1-ecd7-4ace-a6ef-ef73ba6b8ba5",
"targetPartnerName": "Test_Test_DB_AG",
"targetPartnerTenantId": "817512dd-0689-47a0-bbf2-a7f11ae1fc11",
"targetPartnerEmailId": "817512d3-0689-47a0-bbf2-a7f11ae1fc11",
"transferDirection": 2,
"ignoreEligibilityCheck": false,
"lastModifiedUser": "1671774b-679f-4543-a152-1f8b14006c0e",
"lineItems": [{
"id": 0,
"subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
"billingCycle": "unknown",
"quantity": 0,
"productType": 5,
"status": "InProgress"
}],
"links": {
"self": {
"uri": "/customers/a624f7f8-408b-49d0-9320-df79e56bed55/transfers/43fb1d3a-79fe-45a9-863e-9a4acf17b630",
"method": "GET",
"headers": []
}
}
}
Ответ REST
В случае успешного выполнения этот метод возвращает заполненный ресурс TransferEnity в тексте ответа.
Коды успешного выполнения и ошибок в ответе
Каждый ответ поставляется с кодом состояния HTTP, который указывает на успешность или сбой и дополнительные сведения об отладке. Используйте средство трассировки сети для чтения этого кода, типа ошибки и других параметров. См. полный список кодов ошибок.
Пример ответа
HTTP/1.1 201 Created
Content-Length: 138
Content-Type: application/json; charset=utf-8
MS-RequestId: 4fa6dad6-a89f-4875-8247-7294a10ae1cf
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
X-Locale: en-US,en-US
{
"id": "43fb1d3a-79fe-45a9-863e-9a4acf17b630",
"status": "Pending",
"transferType": 3,
"customerEmailId": "",
"createdTime": "2024-04-30T18:31:41.5133355Z",
"lastModifiedTime": "2024-04-30T18:31:41Z",
"expirationTime": "2024-05-31T00:00:00Z",
"customerName": "ipdbtrans2",
"customerTenantId": "a624f7f8-408b-49d0-9320-df79e56bed55",
"partnertenantid": "817512d3-0689-47a0-bbf2-a7f11ae1fc11",
"sourcePartnerName": "Test_Test_IP4_AG",
"sourcePartnerTenantId": "a94dcde1-ecd7-4ace-a6ef-ef73ba6b8ba5",
"targetPartnerName": "Test_Test_DB_AG",
"targetPartnerTenantId": "817512d3-0689-47a0-bbf2-a7f11ae1fc11",
"targetPartnerEmailId": "817512d3-0689-47a0-bbf2-a7f11ae1fc11",
"transferDirection": 1,
"ignoreEligibilityCheck": false,
"lastModifiedUser": "7ffdaa28-3b1c-4a61-b580-e1aa6ecf833c",
"links": {
"self": {
"uri": "/customers/a624f7f8-408b-49d0-9320-df79e56bed55/transfers/43fb1d3a-79fe-45a9-863e-9a4acf17b630",
"method": "GET",
"headers": []
}
}
}