Potwierdzanie akceptacji umowy klienta firmy Microsoft przy użyciu interfejsów API Centrum partnerskiego
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
Centrum partnerskie obsługuje obecnie potwierdzenie akceptacji umowy klienta firmy Microsoft tylko w chmurze publicznej firmy Microsoft.
W tym artykule opisano sposób potwierdzania lub ponownego potwierdzania akceptacji przez klienta 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 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 uwierzytelnianie w Centrum Partnerów. Ten scenariusz obsługuje tylko uwierzytelnianie aplikacji i użytkownika.
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 konta klienta poszukaj identyfikatora Microsoft w sekcji Informacje o koncie klienta. Identyfikator Firmy Microsoft jest taki sam jak identyfikator klienta (customer-tenant-id
).Data (dataAgreed), kiedy klient zaakceptował Umowę z Klientem Microsoft.
Informacje o użytkowniku z organizacji klienta, który zaakceptował Umowę z Klientem Microsoft. Obejmuje to:
- Imię
- Nazwisko
- Adres e-mail
- Numer telefonu (opcjonalnie)
Jeśli następujące wartości zmienią się dla klienta, Centrum partnerskie będzie zezwalać na utworzenie innej umowy dla tego klienta: Imię Nazwisko Adres e-mail numer telefonu. W przeciwnym razie partnerzy otrzymają następujący kod błędu z powodu utworzenia zduplikowanego klienta
{
"code": 600061,
"message": "A partner confirmed agreement already exists for the customer.",
"description": "A partner confirmed agreement already exists for the customer.",
"errorName": "PartnerConfirmedAgreementAlreadyExists",
"isRetryable": false,
"parameters": {},
"errorMessageExtended": "InternalErrorCode=600061"
}
.NET
Aby potwierdzić lub ponownie potwierdzić akceptację umowy klienta firmy Microsoft:
Pobierz metadane umowy dla Umowy z Klientem Microsoft. Należy uzyskać identyfikator szablonu umowy z klientem Microsoft. Aby uzyskać więcej informacji, zobacz Pobieranie metadanych umowy dla Umowy Klienta Microsoft.
// IAggregatePartner partnerOperations; string agreementType = "MicrosoftCustomerAgreement"; var microsoftCustomerAgreementDetails = partnerOperations.AgreementDetails.ByAgreementType(agreementType).Get().Items.Single();
Utwórz nowy obiekt umowy zawierający szczegóły potwierdzenia.
Użyj kolekcji IAgreggatePartner.Customers i wywołaj metodę ById z określonym identyfikatorem dzierżawy klienta.
Użyj właściwości umów , a następnie wywołaj Create lub CreateAsync.
// string selectedCustomerId; var agreementToCreate = new Agreement { DateAgreed = DateTime.UtcNow, TemplateId = microsoftCustomerAgreementDetails.TemplateId, PrimaryContact = new Contact { FirstName = "Tania", LastName = "Carr", Email = "someone@example.com", PhoneNumber = "1234567890" } }; Agreement agreement = partnerOperations.Customers.ById(selectedCustomerId).Agreements.Create(agreementToCreate);
Kompletny przykład można znaleźć w klasie CreateCustomerAgreement z projektu aplikacji testowej konsoli.
Żądanie REST
Aby potwierdzić lub ponownie potwierdzić akceptację umowy klienta firmy Microsoft:
- Pobierz metadane umowy dla Umowy z Klientem Microsoft. Należy uzyskać templateId Umowy z Klientem Microsoft. Aby uzyskać więcej informacji, zobacz Uzyskaj metadane umowy dla usługi Microsoft Customer Agreement.
- Utwórz nową umowę zasobów, aby potwierdzić, że klient zaakceptował umowę klienta firmy Microsoft. Użyj następującej składni żądania REST .
Składnia żądania
Metoda | Żądanie URI |
---|---|
POST | {baseURL}/v1/customers/{customer-tenant-id}/umowy HTTP/1.1 |
Parametr identyfikatora URI
Użyj następującego parametru zapytania, aby określić klienta, którego potwierdzasz.
Nazwa | Typ | Wymagane | Opis |
---|---|---|---|
identyfikator klienta-dzierżawcy | GUID | Tak | Wartość jest identyfikatorem GUID sformatowanym customer-tenant-id , który jest identyfikatorem umożliwiającym określenie klienta. |
Nagłówki żądań
Aby uzyskać więcej informacji, zobacz Nagłówki REST Centrum partnerskiego.
Treść żądania
W tej tabeli opisano wymagane właściwości w treści żądania REST.
Nazwa | Typ | Opis |
---|---|---|
Umowa | obiekt | Szczegóły podane przez partnera w celu potwierdzenia akceptacji przez klienta Umowy z Klientem Microsoft. |
Umowa
W tej tabeli opisano minimalne pola wymagane do utworzenia Agreement zasobu.
Własność | Typ | Opis |
---|---|---|
główny kontakt | kontakt | Informacje o użytkowniku z organizacji klienta, który zaakceptował Umowę z Klientem Microsoft, w tym: imię (firstName), nazwisko (lastName), adres e-mail, i numer telefonu (phoneNumber) (opcjonalnie) |
dataUzgodniona | ciąg w formacie daty i godziny UTC | Data zaakceptowania umowy przez klienta. |
Identyfikator szablonu | struna | Unikatowy identyfikator typu umowy zaakceptowanego przez klienta. Aby uzyskać templateId dla Umowy z Klientem Microsoft, pobierz metadane tej umowy. Aby uzyskać metadane dotyczące Umowy Klienta Microsoft, zobacz Szczegóły umowy. |
typ | struna | Typ umowy zaakceptowany przez klienta. Użyj opcji "MicrosoftCustomerAgreement", jeśli klient zaakceptował umowę klienta firmy Microsoft. |
Przykład żądania
POST https://api.partnercenter.microsoft.com/v1/customers/14876998-c0dc-46e6-9d0c-65a57a6c32ec/agreements HTTP/1.1
Authorization: Bearer <token>
Content-Type: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
{
"primaryContact": {
"firstName": "Tania",
"lastName": "Carr",
"email": "someone@example.com",
"phoneNumber": "1234567890"
},
"templateId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"dateAgreed": "2018-06-14T00:00:00.000Z",
"type": "MicrosoftCustomerAgreement"
}
Odpowiedź REST
W przypadku powodzenia ta metoda zwraca umowę zasobu.
Kody sukcesu i błędów odpowiedzi
Każda odpowiedź zawiera kod stanu HTTP, który wskazuje powodzenie lub niepowodzenie i dodatkowe informacje o debugowaniu.
Użyj narzędzia do śledzenia sieci, aby odczytać ten kod, typ błędu i dodatkowe parametry. Aby uzyskać pełną listę, zobacz Kody błędów Centrum partnerskiego REST.
Przykład odpowiedzi
HTTP/1.1 201 Created
Content-Length: 261
Content-Type: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: aaaa0000-bb11-2222-33cc-444444dddddd
{
"userId": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
"primaryContact": {
"firstName": "Tania",
"lastName": "Carr",
"email": "someone@example.com",
"phoneNumber": "1234567890"
},
"templateId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
"dateAgreed": "2018-06-14T00:00:00.000Z",
"type": "MicrosoftCustomerAgreement"
}