Поделиться через

Получение ссылки на скачивание для шаблона клиентского соглашения Майкрософт

  • Статья

применимо к: Центр партнеров

не применяется к: Центр партнеров, управляемый 21Vianet | Центр партнеров для Microsoft Cloud для государственных организаций США

В настоящее время ресурс AgreementDocument поддерживается только в Центре партнеров и исключительно в общедоступном облаке Майкрософт.

В этой статье описывается, как получить ссылку для скачивания шаблона клиентского соглашения Майкрософт на основе страны или региона клиента.

Необходимые условия

  • Если вы используете пакет SDK для .NET для Центра партнеров, требуется версия 1.14 или более новая.

    Важный

    По состоянию на июнь 2023 г. последняя версия пакета SDK для .NET для Центра партнеров 3.4.0 теперь архивируется. Вы можете скачать релиз SDK из GitHubвместе с файлом readme, который содержит полезные сведения.

    Компании-партнёры поощряются продолжать использовать REST API центра партнёров .

  • Учетные данные, как описано в аутентификации Центра партнеров. Этот сценарий поддерживает только аутентификацию приложение+пользователь.

  • Страна или регион клиента, к которому применяется шаблон клиентского соглашения Майкрософт.

  • Язык, на котором должен быть локализован шаблон клиентского соглашения Майкрософт.

Важный

  • Клиентское соглашение Майкрософт специфично для конкретной страны или региона. При запросе ссылки на скачивание шаблона клиентского соглашения Майкрософт обязательно укажите правильную страну или регион в зависимости от расположения клиента. или список поддерживаемых стран или регионов, см. список поддерживаемых стран или регионов и языков.
  • Для некоторых стран и регионов клиентское соглашение Майкрософт доступно на нескольких языках. Для лучшего взаимодействия с клиентами выберите язык, который лучше всего соответствует потребностям клиента. Список поддерживаемых языков см. в списке поддерживаемых стран или регионов и языков.
  • Этот метод поддерживается только в клиентском соглашении Майкрософт.

.СЕТЬ

Чтобы получить ссылку для скачивания шаблона клиентского соглашения Майкрософт, выполните следующие действия.

  1. Получите метаданные для Клиентского соглашения корпорации Майкрософт. Необходимо получить templateId клиентского соглашения Майкрософт. Дополнительные сведения см. в разделе Получение метаданных соглашения для клиентского соглашения Майкрософт.

    // IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

AgreementMetaData microsoftCustomerAgreementDetails = partnerOperations.AgreementDetails.   ByAgreementType(agreementType).Get().Items.Single();

  2. Используйте коллекцию IAggregatePartner.AgreementTemplates.

  3. Вызовите метод ById и укажите templateId клиентского соглашения Майкрософт.

  4. Получите свойство Document.

  5. Вызовите метод ByCountry и укажите страну или регион клиента, к которому применяется шаблон соглашения. По умолчанию запрос устанавливается на США, если метод не указан. Список поддерживаемых кодов страны или региона см. в списке поддерживаемых стран или регионов и языков. Метод чувствителен к регистру.

  6. Вызовите метод ByLanguage и укажите язык локализации шаблона соглашения. Запрос по умолчанию en-US, если метод не указан или указанный код страны или региона не поддерживается для указанной страны или региона. Список поддерживаемых языковых кодов см. в списке поддерживаемых стран и регионов и языков.

  7. Вызовите метод Get или GetAsync.

    // IAggregatePartner partnerOperations;

string customerCountry = "US";

string languageForLocalization = "en-US";

var agreementDocument = partnerOperations.   AgreementTemplates.ById   (microsoftCustomerAgreementDetails.   TemplateId).Document.ByCountry   (customerCountry).ByLanguage   (languageForLocalization).Get();

Полный пример можно найти в классе GetAgreementDetails из проекта консольного тестового приложения.

Запрос REST

Чтобы получить ссылку для скачивания шаблона клиентского соглашения Майкрософт, выполните следующие действия.

  1. Получите метаданные для Клиентского соглашения корпорации Майкрософт. Необходимо получить templateId клиентского соглашения Майкрософт. Дополнительные сведения см. в разделе Получение метаданных соглашения для клиентского соглашения Майкрософт.

  2. Создайте запрос REST для получения ресурса AgreementDocument. Пример см. в примере синтаксиса запроса . Необходимо указать следующие сведения:

    • templateId клиентского соглашения Майкрософт
    • Страна или регион, к которому применяется шаблон клиентского соглашения Майкрософт
    • Язык, на котором должен быть локализован шаблон клиентского соглашения Майкрософт

Синтаксис запроса

Используйте следующий синтаксис запроса для этого ресурса:

Метод URI запроса
ПОЛУЧИТЬ {baseURL}/v1/agreementtemplates/{agreement-template-id}/document?language={language}&country={country} HTTP/1.1

Параметры URI

С запросом можно использовать следующие параметры URI:

Имя Тип Обязательно Описание
идентификатор-шаблона-соглашения струна Да Уникальный идентификатор типа соглашения. Вы можете получить "templateId" для клиентского соглашения Майкрософт, извлекая метаданные соглашения. Дополнительные сведения см. в разделе Получение метаданных соглашения для клиентского соглашения Майкрософт. Этот параметр чувствителен к регистру.
страна струна Нет Указывает страну или регион, к которому применяется шаблон соглашения. Запрос по умолчанию устанавливается на США, если параметр не указан. Список поддерживаемых кодов страны или региона см. в списке поддерживаемых стран или регионов и языков.
Язык струна Нет Указывает язык, на котором должен быть локализован шаблон соглашения. Запрос по умолчанию использует en-US, если параметр не указан или код страны/региона не поддерживается для указанной страны или региона. Список поддерживаемых кодов страны или региона см. в списке поддерживаемых стран и регионов.

Заголовки запросов

Для получения дополнительной информации см. заголовки REST Центра партнеров.

Текст запроса

Нет.

Пример запроса

GET https://api.partnercenter.microsoft.com/v1/agreementtemplates/aaaabbbb-0000-cccc-1111-dddd2222eeee/document?language=en-US&country=US HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd

Ответ REST

В случае успешного выполнения этот метод возвращает ресурс AgreementDocument в тексте ответа.

Ресурс имеет свойство downloadUri, содержащее строку URL-адреса, которую можно использовать для скачивания шаблона соглашения. При каждом выполнении запроса возвращается другая ссылка. Срок действия этой ссылки истекает через пять минут.

Коды успешного ответа и ошибки

Каждый ответ содержит код состояния HTTP, указывающий на успешность или сбой, а также другие сведения об отладке.

Используйте средство трассировки сети для чтения этого кода, типа ошибки и других параметров. Полный список см. в разделе Коды ошибок REST Центра партнеров.

Пример ответа

HTTP/1.1 200 OK
Content-Length: 620
Content-Type: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
{
    "displayUri":"https://wopihost.int.l2o.microsoft.com/v1/officehost/agreement/files/Preview...",
    "downloadUri":"https://l2oagreementintbn2.blob.core.windows.net/agreementscontainer/Preview...",
    "language":"en-US",
    "country":"US"
}

Список поддерживаемых стран и регионов и языков

Важный

Свойство кода страны или региона чувствительно к регистру. Не забудьте использовать правильный регистр, указанный в этой таблице:

Страна или регион Код страны Поддерживаемые коды языка
Аландские острова ТОПОР en-US
Афганистан AF en-US
Албания АЛЬ en-US
Алжир DZ en-US, fr-FR, en-US
Американское Самоа КАК en-US
Андорра ОБЪЯВЛЕНИЕ en-US
Ангола АО en-US, pt-PT
Ангилья Искусственный интеллект en-US
Антарктида AQ en-US
Антигуа и Барбуда AG en-US
Аргентина АР en-US, es-ES
Армения ДП en-US
Аруба AW en-US
Австралия АУ en-US
Австрия У en-US, de-DE
Азербайджан АЗ английский-Соединенные Штаты
Багамские Острова бакалавр наук en-US
Бахрейн BH en-US, ar-SA
Бангладеш BD en-US
Барбадос BB en-US
Беларусь от en-US, ru-RU
Бельгия БЫТЬ en-US, nl-NL
Белиз BZ en-US, es-ES
Бенин BJ en-US
Бермуды BM en-US
Бутан BT en-US
Боливия БО en-US, es-ES
Бонэйр BQ en-US
Босния и Герцеговина БА en-US
Ботсвана BW en-US
Буве-Остров BV en-US
Бразилия BR en-US, pt-BR
Британская индийская океанская территория ИО en-US
Британские Виргинские острова VG en-US
Бруней МЛРД en-US
Болгария BG en-US, bg-BG
Буркина-Фасо BF en-US
Бурунди BI en-US
Кот-д'Ивуар СИ en-US, fr-FR
Кабо-Верде РЕЗЮМЕ en-US, pt-PT
Камбоджа KH en-US
Камерун СМ en-US, fr-FR
Канада Центр сертификации en-US, fr-FR
Каймановы острова KY английский (США), английский (США)
Центральноафриканская Республика CF en-US
Чад TD en-US
Чили CL en-US, es-ES
Остров Рождества CX en-US
Кокос (Килинг) Острова Субтитры en-US
Колумбия СО en-US, es-ES
Коморские Острова КМ en-US
Конго (DRC) CD (компакт-диск) ен-УС
Конго Компьютерная графика en-US
Острова Кука CK en-US
Коста-Рика CR en-US, es-ES
Хорватия Отдел кадров английский (США), хорватский (Хорватия)
Кюрасао CW en-US
Кипр CY en-US
Чехия CZ en-US, cs-CZ
Дания DK en-US, da-DK
Джибути ДИДЖЕЙ en-US
Доминика ДМ en-US
Доминиканская Республика ДЕЛАЙ en-US, es-ES
Эквадор Европейское сообщество en-US
Египет ЕГ en-US, ar-SA
Сальвадор SV en-US, es-ES
Экваториальная Гвинея GQ en-US
Эритрея ОТДЕЛЕНИЕ НЕОТЛОЖНОЙ ПОМОЩИ en-US
Эстония EE en-US, et-EE
eSwatini SZ en-US
Эфиопия Восточное время en-US
Фолклендские острова FK en-US
Фарерские о-ва В зависимости от предоставленного контекста, "FO" может остаться как есть, или быть соответствующим образом адаптировано или переведено на русский язык. en-US
Фиджи FJ en-US
Финляндия FI en-US, fi-FI
Франция ФР en-US, fr-FR
Французская Гвиана GF en-US, fr-FR
Французская Полинезия PF en-US
Французские южные территории TF en-US
Габон ГА en-US
Гамбия GM en-US
Грузия GE en-US
Германия ДЕ en-US, de-DE
Гана GH en-US
Гибралтар ГИ en-US
Греция ГР en-US, el-GR
Гренландия GL en-US
Гренада GD en-US
Гваделупа терапевт en-US
Гуам ГУ en-US
Гватемала GT en-US, es-ES
Гернси ГГ en-US
Гвинея GN en-US
Guinea-Bissau GW en-US
Гайана Гайана en-US
Гаити HT en-US
Остров Херд и острова Макдональд хм en-US
Гондурас HN en-US, es-ES
Специальный административный район Гонконга Гонконг английский (США), китайский (Гонконг)
Венгрия ХУ en-US, hu-HU
Исландия ЕСТЬ en-US
Индия В en-US, hi-IN
Индонезия ИДЕНТИФИКАТОР en-US, id-ID
Ирак коэффициент интеллекта en-US, ar-SA
Ирландия Internet Explorer en-US
Isle of Man IM en-US
Израиль Иллинойс en-US, he-IL
Италия ИТ en-US, it-IT
Ямайка JM en-US
Ян Майен XJ en-US
Япония JP en-US, ja-JP
Джерси JE en-US
Иордания ДЖО en-US, ar-SA
Казахстан КЗ en-US, kk-KZ
Кения КЕ en-US
Кирибати КИ en-US
Корея КР en-US, ko-KR
Косово XK en-US
Кувейт кВт en-US, ar-SA
Киргизия килограмм en-US, ru-RU
Лаос Лос-Анджелес en-US
Латвия LV en-US, lv-LV
Ливан ЛБ en-US, ar-SA
Лесото LS en-US
Либерия LR en-US
Ливия LY en-US, ar-SA
Лихтенштейн LI en-US, de-DE
Литва LT англ-US, лит-LT
Люксембург ЛУ en-US, fr-FR
Специальный административный район Macao МО английский (США), китайский (Гонконг)
Мадагаскар мг en-US
Малави МВт en-US
Малайзия МОЙ en-US, ms-MY
Мальдивы MV en-US
Мали МЛ ен-УС
Мальта МТ en-US
Маршалловы Острова MH en-US
Мартиника MQ en-US
Мавритания МИСТЕР en-US
Маврикий МЮ en-US, ar-SA
Майотта Ютуб en-US
Мексика MX en-US, es-ES
Микронезия FM en-US
Молдова доктор медицины en-US, ro-RO
Монако MC en-US, fr-FR
Монголия MN en-US
Черногория Я en-US
Монтсеррат ГОСПОЖА en-US
Марокко МАМА en-US, fr-FR, en-US
Мозамбик MZ en-US
Мьянма MM en-US
Намибия NA en-US
Науру NR en-US
Непал НП en-US
Нидерланды NL en-US, nl-NL
Новая Каледония NC en-US
Новая Зеландия NZ en-US
Никарагуа NI en-US, es-ES
Нигер NE en-US
Нигерия NG en-US
Ниуэ НЮ en-US
Остров Норфолк NF en-US
Северные Марианские острова депутат en-US
Северная Македония MK en-US
Норвегия НЕТ en-US, nb-NO
Оман ОМ en-US, ar-SA
Пакистан PK en-US
Палау Пароль en-US
Палестинский орган P.S. en-US
Панама PA en-US, es-ES
Папуа-Новая Гвинея PG en-US
Парагвай PY en-US, es-ES
Перу PE en-US, es-ES
Филиппины PH en-US
Острова Pitcairn PN en-US
Польша PL en-US, pl-PL
Португалия PT en-US, pt-PT
Пуэрто-Рико пиар en-US, en-US
Катар Обеспечение качества en-US, ar-SA
Реюньон РЕ en-US
Румыния RO en-US, ro-RO
Россия RU en-US, ru-RU
Руанда RW en-US, fr-FR
Сан-Томе и Príncipe УЛ en-US, fr-FR
Саба размер XS en-US
Saint-Barthélemy BL en-US
Сент-Китс и Невис КН en-US
Сент-Люсия ЛК en-US, en-US
Сен-Мартен МФ en-US, en-US
Сен-Пьер и Микелон премьер-министр en-US
Сент-Винсент и Grenadines Венчурный капитал en-US
Самоа WS en-US
Сан-Марино SM en-US
Саудовская Аравия СА en-US
Сенегал SN en-US, fr-FR
Сербия RS en-US, sr-Latn-RS, en-US
Сейшельские Острова SC en-US
Сьерра-Леоне SL en-US
Сингапур SG en-US, zh-SG
Синт Эстатиус XE en-US
Синт-Мартен SX английский-США, английский-США
Словакия SK en-US, sk-SK
Словения СИ en-US, sl-SI
Соломоновы Острова SB en-US
Сомали Итак en-US
Южная Африка ЗА en-US
Южная Георгия и Южные Сандвичевы острова GS en-US
Южный Судан SS en-US
Испания ES en-US, es-ES, en-US, en-US
Шри-Ланка LK en-US
Сент-Хелена, Вознесение, Тристан да Кунья SH en-US
Суринам SR en-US
Шпицберген SJ en-US
Швеция SE en-US, sv-SE
Швейцария CH en-US, fr-FR, en-US, en-US
Тайвань TW en-US, zh-HK
Таджикистан TJ en-US
Танзания TZ en-US
Таиланд ТХ en-US, th-TH
Timor-Leste TL en-US
Того TG en-US
Токелау Технические Знания en-US
Тонга КОМУ en-US
Тринидад и Тобаго TT ен-УС
Тунис TN en-US, fr-FR, en-US
Türkiye TR en-US, tr-TR
Туркменистан ТМ en-US
Острова Турки и Кайкос TC en-US
Тувалу ТЕЛЕВИДЕНИЕ en-US
Внешние малые острова США UM en-US
Виргинские острова США VI en-US
Уганда УГ en-US
Украина UA en-US, uk-UA
Объединённые Арабские Эмираты AE en-US, ar-SA
Великобритания ГБ en-US
США США en-US
Уругвай UY en-US, es-ES
Узбекистан UZ en-US, ru-RU
Вануату VU en-US
Ватикан VA en-US
Венесуэла VE en-US, es-ES
Вьетнам VN en-US, vi-VN
Уоллис и Футуна WF en-US
Йемен Да en-US, ar-SA
Замбия ZM en-US
Зимбабве ZW en-US