Obter confirmação da aceitação do cliente do Contrato de Cliente Microsoft

Artigo
03/10/2024

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 Contrato é suportado pelo Partner Center apenas na nuvem pública da Microsoft.

Este artigo explica como você pode recuperar confirmações da aceitação do Contrato de Cliente Microsoft por um 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.
Um ID de cliente (customer-tenant-id). Se não souber o ID do cliente, pode procurá-lo no Partner Center selecionando a área de trabalho Clientes e, em seguida, o cliente na lista de clientes e, em seguida, Conta. Na página Conta do cliente, procure a ID da Microsoft na seção Informações da Conta do Cliente. A ID da Microsoft é a mesma que a ID do cliente (customer-tenant-id).

.NET

Para recuperar a(s) confirmação(ões) de aceitação do cliente que foi fornecida anteriormente:

Use a coleção IAggregatePartner.Customers e chame o método ById com o identificador de cliente especificado.
Procure a propriedade Agreements e filtre os resultados para o Contrato de Cliente da Microsoft chamando o método ByAgreementType .
Chame o método Get ou GetAsync .

// IAggregatePartner partnerOperations;
// string selectedCustomerId;

string agreementType = "MicrosoftCustomerAgreement";

var customerAgreements = partnerOperations.Customers.ById(selectedCustomerId).Agreements.ByAgreementType(agreementType).Get();

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

Pedido REST

Para recuperar a confirmação de aceitação do cliente que foi fornecida anteriormente:

Crie uma solicitação REST para recuperar a coleção Agreements para o cliente.
Use o parâmetro de consulta agreementType para definir o escopo dos resultados somente para o Contrato de Cliente da Microsoft.

Sintaxe da solicitação

Use a seguinte sintaxe de solicitação:

Método	URI do pedido
GET	{baseURL}/v1/customers/{customer-tenant-id}/agreements?agreementType={agreement-type} HTTP/1.1

Parâmetros de URI

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

Nome	Type	Obrigatório	Description
ID do cliente-locatário	GUID	Sim	O valor é um GUID formatado CustomerTenantId que permite especificar um cliente.
tipo de acordo	string	Não	Esse parâmetro retorna todos os metadados do contrato. Use esse parâmetro para definir o escopo da resposta de consulta para um tipo de contrato específico. Os valores suportados são: MicrosoftCloudAgreement que inclui apenas metadados de contrato do tipo MicrosoftCloudAgreement. MicrosoftCustomerAgreement que inclui apenas metadados de contrato do tipo MicrosoftCustomerAgreement. * que retorna todos os metadados do contrato. (Não use * a menos que seu código tenha a lógica necessária para lidar com tipos de contrato inesperados.) Nota: Se o parâmetro URI não for especificado, o padrão da consulta será MicrosoftCloudAgreement para compatibilidade com versões anteriores. A Microsoft pode introduzir metadados de contrato com novos tipos de contrato a qualquer momento.

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/customers/14876998-c0dc-46e6-9d0c-65a57a6c32ec/agreements?agreementType=MicrosoftCustomerAgreement 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 uma coleção de recursos de Acordo no corpo da resposta.

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
{
    "totalCount": 2,
    "items":
    [
        {
            "primaryContact":
            {
                "firstName":"Tania",
                "lastName":"Carr",
                "email":"SomeEmail@example.com"
                "phoneNumber":"1234567890"
            },
            "templateId":"117a77b0-9360-443b-8795-c6dedc750cf9",
            "dateAgreed":"2019-08-26T00:00:00",
            "type":"MicrosoftCustomerAgreement",
            "agreementLink":"https://aka.ms/customeragreement"
        },
        {
            "primaryContact":
            {
                "firstName":"Tania",
                "lastName":"Carr",
                "email":"SomeEmail@example.com"
                "phoneNumber:"1234567890"
            },
            "templateId":"117a77b0-9360-443b-8795-c6dedc750cf9",
            "dateAgreed":"2019-08-27T00:00:00",
            "type":"MicrosoftCustomerAgreement",
            "agreementLink":"https://aka.ms/customeragreement"
        }
    ]
}

Partilhar via