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

Aplica-se a: Partner Center

Não se aplica a: Partner Center operado pela 21Vianet | Partner Center for 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 idioma do cliente.

Pré-requisitos

• Se você estiver usando o SDK .NET do Partner Center, 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 .NET do Partner Center foi arquivada. Você pode baixar a versão do SDK do GitHub, juntamente com um arquivo readme que contém informações úteis.

  Os parceiros são incentivados a continuar a usar as APIs REST do Partner Center.

• Credenciais conforme descrito na autenticação do Partner Center. Este cenário suporta apenas a autenticação App+User.

• 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.

.NET

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

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

   // IAggregatePartner partnerOperations;
   
   string agreementType = "MicrosoftCustomerAgreement";
   
   AgreementMetaData microsoftCustomerAgreementDetails = partnerOperations.AgreementDetails.   ByAgreementType(agreementType).Get().Items.Single();
   

2. Use a coleção IAggregatePartner.AgreementTemplates.

3. Chame o método ById e especifique o templateId do Contrato de Cliente da Microsoft.

4. Buscar a propriedade Document .

5. 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. Este método diferencia maiúsculas de minúsculas.

6. Chame o método ByLanguage e especifique o idioma no qual o modelo de contrato deve ser localizado. O padrão da consulta é 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 uma lista de códigos de idiomas suportados, consulte Lista de países/regiões e idiomas suportados.

7. 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.

Pedido REST

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

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

2. 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 Microsoft
   • O país/região ao qual o modelo de Contrato de Cliente 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:

Parâmetros de URI

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

Cabeçalhos do pedido

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

Corpo do pedido

Nenhum.

Exemplo de solicitação

GET https://api.partnercenter.microsoft.com/v1/agreementtemplates/117a77b0-9360-443b-8795-c6dedc750cf9/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 do 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 sucesso e 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, consulte 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