Pobieranie potwierdzenia akceptacji przez klienta umowy klienta firmy Microsoft

  • Artykuł

Dotyczy: Centrum partnerskie

Nie dotyczy: Centrum partnerskie obsługiwane przez firmę 21Vianet | Centrum partnerskie dla chmury firmy Microsoft dla instytucji rządowych USA

Zasób Umowy jest obecnie obsługiwany przez Centrum partnerskie tylko w chmurze publicznej firmy Microsoft.

W tym artykule wyjaśniono, jak można pobrać potwierdzenia akceptacji Umowa z Klientem Microsoft przez klienta.

Wymagania wstępne

  • Jeśli używasz zestawu .NET SDK Centrum partnerskiego, wymagana jest wersja 1.14 lub nowsza.

    Ważne

    Od czerwca 2023 r. najnowsza wersja zestawu .NET SDK Centrum partnerskiego 3.4.0 jest teraz archiwizowana. Możesz pobrać wersję zestawu SDK z usługi GitHub wraz z plikiem readme zawierającym przydatne informacje.

    Zachęcamy partnerów do dalszego korzystania z interfejsów API REST Centrum partnerskiego.

  • Poświadczenia zgodnie z opisem w temacie Uwierzytelnianie w Centrum partnerskim. Ten scenariusz obsługuje tylko uwierzytelnianie aplikacji i użytkowników.

  • Identyfikator klienta (customer-tenant-id). Jeśli nie znasz identyfikatora klienta, możesz wyszukać go w Centrum partnerskim, wybierając obszar roboczy Klienci , a następnie klienta z listy klienta, a następnie pozycję Konto. Na stronie Konto klienta poszukaj identyfikatora Microsoft w sekcji Informacje o koncie klienta. Identyfikator Microsoft jest taki sam jak identyfikator klienta (customer-tenant-id).

.NET

Aby pobrać potwierdzenia akceptacji klienta, które zostały wcześniej podane:

  • Użyj kolekcji IAggregatePartner.Customers i wywołaj metodę ById z określonym identyfikatorem klienta.

  • Pobierz właściwość Agreement i przefiltruj wyniki, aby Umowa z Klientem Microsoft przez wywołanie metody ByAgreementType.

  • Wywołaj metodę Get lub GetAsync .

// IAggregatePartner partnerOperations;
// string selectedCustomerId;

string agreementType = "MicrosoftCustomerAgreement";

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

Kompletny przykład można znaleźć w klasie GetCustomerAgreements z projektu aplikacji testowej konsoli.

Żądanie REST

Aby pobrać potwierdzenie akceptacji klienta, która została wcześniej podana:

  1. Utwórz żądanie REST w celu pobrania kolekcji Umów dla klienta.

  2. Użyj parametru zapytania agreementType, aby ograniczyć zakres wyników tylko do Umowa z Klientem Microsoft.

Składnia żądania

Użyj następującej składni żądania:

Method Identyfikator URI żądania
GET {baseURL}/v1/customers/{customer-tenant-id}/agreement?agreementType={agreement-type} HTTP/1.1

Parametry identyfikatora URI

Możesz użyć następujących parametrów identyfikatora URI z żądaniem:

Nazwisko Type Wymagania opis
identyfikator dzierżawy klienta Identyfikator GUID Tak Wartość jest identyfikatorem GUID sformatowanym identyfikatorem CustomerTenantId , który umożliwia określenie klienta.
typ umowy string Nie Ten parametr zwraca wszystkie metadane umowy. Użyj tego parametru, aby określić zakres odpowiedzi zapytania na określony typ umowy. Obsługiwane wartości to:

MicrosoftCloudAgreement , który zawiera tylko metadane umowy typu MicrosoftCloudAgreement.

MicrosoftCustomerAgreement , który zawiera tylko metadane umowy typu MicrosoftCustomerAgreement.

* zwraca wszystkie metadane umowy. (Nie używaj * , chyba że kod ma niezbędną logikę do obsługi nieoczekiwanych typów umów).

Uwaga: jeśli parametr URI nie jest określony, zapytanie jest domyślnie ustawione na MicrosoftCloudAgreement w celu zapewnienia zgodności z poprzednimi wersjami. Firma Microsoft może w dowolnym momencie wprowadzać metadane umowy z nowymi typami umów.

Nagłówki żądań

Aby uzyskać więcej informacji, zobacz Nagłówki REST Centrum partnerskiego.

Treść żądania

Brak.

Przykład żądania

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: ab993325-1605-4cf4-bac4-fb584142a31b

Odpowiedź REST

Jeśli ta metoda powiedzie się, zwraca kolekcję zasobów umowy w treści odpowiedzi.

Kody powodzenia i błędów odpowiedzi

Każda odpowiedź zawiera kod stanu HTTP, który wskazuje powodzenie lub niepowodzenie i inne informacje o debugowaniu.

Użyj narzędzia do śledzenia sieci, aby odczytać ten kod, typ błędu i inne parametry. Aby uzyskać pełną listę, zobacz Kody błędów REST Centrum partnerskiego.

Przykład odpowiedzi

HTTP/1.1 200 OK
Content-Length: 620
Content-Type: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: ab993325-1605-4cf4-bac4-fb584142a31b
{
    "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"
        }
    ]
}