Uzyskiwanie potwierdzenia akceptacji przez klienta umowy klienta firmy Microsoft
Dotyczy: Centrum Partnerskie
nie ma zastosowania do: Centrum partnerskie obsługiwane przez firmę 21Vianet | Centrum partnerskie dla chmury firmy Microsoft dla instytucji rządowych USA
Zasób Agreement jest obecnie obsługiwany przez Centrum partnerskie tylko w chmurze publicznej firmy Microsoft.
W tym artykule wyjaśniono, jak można pobrać potwierdzenia akceptacji umowy klienta firmy Microsoft.
Warunki wstępne
Jeśli używasz zestawu .NET SDK Centrum partnerskiego, wymagana jest wersja 1.14 lub nowsza.
Ważny
Od czerwca 2023 r. najnowsza wersja zestawu .NET SDK Centrum partnerskiego 3.4.0 jest teraz archiwizowana. Możesz pobrać wersję zestawu SDK z witryny GitHubwraz z plikiem readme, który zawiera przydatne informacje.
Zachęcamy partnerów do dalszego korzystania z interfejsów API REST centrum partnerskiego.
Poświadczenia zgodnie z opisem w 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 klient z listy klientów, a następnie konto. Na stronie Konto klienta poszukaj identyfikatora Microsoft w sekcji Informacje o koncie klienta. Identyfikator Firmy 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 atrybut Agreements i przefiltruj wyniki, aby uzyskać Umowę Klienta Microsoft, wywołując metodę 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 konsolowej.
Żądanie REST
Aby pobrać potwierdzenie akceptacji klienta, która została wcześniej podana:
Użyj parametru zapytania agreementType, aby ograniczyć zakres wyników tylko do umowy klienta firmy Microsoft.
Składnia żądania
Użyj następującej składni żądania:
Metoda | Identyfikator URI żądania |
---|---|
POBIERZ | {baseURL}/v1/customers/{customer-tenant-id}/agreements?agreementType={agreement-type} HTTP/1.1 |
Parametry identyfikatora URI
Możesz użyć następujących parametrów URI z żądaniem.
Nazwa | Typ | Wymagane | Opis |
---|---|---|---|
identyfikator dzierżawcy klienta | GUID (Globalnie Unikalny Identyfikator) | Tak | Wartość jest identyfikatorem GUID sformatowanym CustomerTenantId, który umożliwia określenie klienta. |
typ umowy | struna | 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óra zawiera tylko metadane umowy typu MicrosoftCloudAgreement. MicrosoftCustomerAgreement, która zawiera tylko metadane umowy typu MicrosoftCustomerAgreement. * zwracające wszystkie metadane umowy. (Nie używaj *, chyba że kod ma niezbędną logikę do obsługi nieoczekiwanych typów umów). Uwaga: Jeśli nie określono parametru URI, zapytanie ustawia się domyślnie na MicrosoftCloudAgreement w celu zapewnienia zgodności z poprzednimi wersjami. Microsoft może w dowolnym momencie wprowadzić metadane umów z nowymi typami umów. |
Nagłówki żądań
Aby uzyskać więcej informacji, zobacz Nagłówki REST Centrum Partnerskiego.
Treść żądania
Żaden.
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: aaaa0000-bb11-2222-33cc-444444dddddd
Odpowiedź REST
W przypadku powodzenia ta metoda zwraca kolekcję zasobów Agreement w treści odpowiedzi.
Kody sukcesu 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: aaaa0000-bb11-2222-33cc-444444dddddd
{
"totalCount": 2,
"items":
[
{
"primaryContact":
{
"firstName":"Tania",
"lastName":"Carr",
"email":"SomeEmail@example.com"
"phoneNumber":"1234567890"
},
"templateId":"aaaabbbb-0000-cccc-1111-dddd2222eeee",
"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":"aaaabbbb-0000-cccc-1111-dddd2222eeee",
"dateAgreed":"2019-08-27T00:00:00",
"type":"MicrosoftCustomerAgreement",
"agreementLink":"https://aka.ms/customeragreement"
}
]
}