Obter um link de download para o modelo do Contrato de Cliente da Microsoft

Artigo
03/05/2024

Aplica-se a: Partner Center

Não se aplica a: Partner Center operado pela 21Vianet | Partner Center para o Microsoft Cloud for US Government

Atualmente, o recurso AgreementDocument é suportado pelo Partner Center apenas na nuvem pública da Microsoft.

Este artigo descreve como obter um link para baixar o modelo de Contrato de Cliente da Microsoft, com base no país/região e no idioma do cliente.

Pré-requisitos

Se você estiver usando o SDK do Partner Center .NET, a versão 1.14 ou mais recente será necessária.

Importante

A partir de junho de 2023, a versão 3.4.0 mais recente do SDK do Partner Center .NET foi arquivada. Você pode baixar a versão do SDK no GitHub, juntamente com um arquivo leiame que contém informações úteis.

Os parceiros são incentivados a continuar a usar as APIs REST do Partner Center.
Credenciais, conforme descrito em Autenticação do Partner Center. Esse cenário dá suporte apenas à autenticação de aplicativo + de usuário.
O país/região do cliente ao qual o modelo de Contrato de Cliente da Microsoft se aplica.
O idioma no qual o modelo de Contrato de Cliente da Microsoft deve ser localizado.

Importante

O Contrato de Cliente da Microsoft é específico do país/região. Ao solicitar um link para baixar o modelo de Contrato de Cliente da Microsoft, certifique-se de especificar o país/região correto com base na localização do cliente. ou lista de países/regiões suportados, consulte Lista de países/regiões e idiomas suportados.
Para alguns países/regiões, o Contrato de Cliente da Microsoft está disponível em vários idiomas. Para obter a melhor experiência do cliente, escolha o idioma que melhor atenda às necessidades do cliente. Para obter a lista de idiomas suportados, consulte Lista de países/regiões e idiomas suportados.
Esse método só é suportado com o Contrato de Cliente da Microsoft.

.NET

Para recuperar um link para baixar o modelo de Contrato de Cliente da Microsoft:

Recupere os metadados do Contrato de Cliente da Microsoft. Você precisa obter o templateId do Contrato de Cliente da Microsoft. Para obter mais informações, confira Obter metadados de contrato do Contrato de Cliente da Microsoft.

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

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

Use a coleção IAggregatePartner.AgreementTemplates.
Chame o método ById e especifique o templateId do Contrato de Cliente da Microsoft.
Busque a propriedade Document .
Chame o método ByCountry e especifique o país/região do cliente ao qual o modelo de contrato se aplica. O padrão da consulta será US se o método não for especificado. Para obter uma lista de códigos de país/região suportados, consulte Lista de países/regiões e idiomas suportados. Esse método diferencia maiúsculas de minúsculas.
Chame o método ByLanguage e especifique o idioma no qual o modelo de contrato deve ser localizado. O padrão da consulta será en-US se o método não for especificado ou se o código de país/região especificado não for suportado para o país/região especificado. Para obter a lista de códigos de idioma suportados, consulte Lista de países/regiões e idiomas suportados.

Chame o método Get ou GetAsync .

// IAggregatePartner partnerOperations;

string customerCountry = "US";

string languageForLocalization = "en-US";

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

Um exemplo completo pode ser encontrado na classe GetAgreementDetails do projeto de aplicativo de teste de console.

Solicitação REST

Para recuperar um link para baixar o modelo de Contrato de Cliente da Microsoft:

Recupere os metadados do Contrato de Cliente da Microsoft. Você precisa obter o templateId do Contrato de Cliente da Microsoft. Para obter mais informações, confira Obter metadados de contrato do Contrato de Cliente da Microsoft.
Crie uma solicitação REST para buscar um recurso AgreementDocument. Para obter um exemplo, consulte o exemplo de sintaxe de solicitação . Você deve especificar as seguintes informações:
- O templateId do Contrato de Cliente da Microsoft
- O país/região ao qual o modelo de Contrato de Cliente da Microsoft se aplica
- O idioma no qual o modelo de Contrato de Cliente da Microsoft deve ser localizado

Sintaxe da solicitação

Use a seguinte sintaxe de solicitação para este recurso:

Método	URI da solicitação
GET	{baseURL}/v1/agreementtemplates/{agreement-template-id}/document?language={language}&country={country} HTTP/1.1

Parâmetros do URI

Você pode usar os seguintes parâmetros de URI com sua solicitação:

Nome	Digitar	Obrigatória	Descrição
agreement-template-id	string	Sim	Identificador exclusivo do tipo de contrato. Você pode obter o templateId para o Contrato de Cliente da Microsoft recuperando os metadados do contrato para o Contrato de Cliente da Microsoft. Para obter mais informações, confira Obter metadados de contrato do Contrato de Cliente da Microsoft. Esse parâmetro diferencia maiúsculas de minúsculas.
country	string	Não	Indica o país/região ao qual o modelo de contrato se aplica. O padrão da consulta será US se o parâmetro não for especificado. Para obter uma lista de códigos de país/região suportados, consulte Lista de países/regiões e idiomas suportados.
linguagem	string	Não	Indica o idioma no qual o modelo de contrato deve ser localizado. O padrão da consulta será en-US se o parâmetro não for especificado ou se o código de país/região especificado em não for suportado para o país/região especificado. Para obter a lista de códigos de país/região suportados, consulte Lista de países/regiões e idiomas suportados.

Cabeçalhos da solicitação

Para obter mais informações, confira Cabeçalhos REST do Partner Center.

Corpo da solicitação

Nenhum.

Exemplo de solicitação

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

Resposta REST

Se bem-sucedido, esse método retorna um recurso AgreementDocument no corpo da resposta.

O recurso tem uma propriedade downloadUri , que contém uma cadeia de caracteres de URL que pode ser usada para baixar o modelo de contrato. Um link diferente é retornado cada vez que você faz uma consulta. Este link expira após cinco minutos.

Códigos de êxito e de erro de resposta

Cada resposta vem com um código de status HTTP que indica sucesso ou falha e outras informações de depuração.

Use uma ferramenta de rastreamento de rede para ler esse código, tipo de erro e outros parâmetros. Para obter a lista completa, confira Códigos de erro REST do Partner Center.

Exemplo de resposta

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"
}

Lista de países/regiões e idiomas suportados