A Microsoft Ügyfélszerződés ügyfél általi elfogadásának megerősítése Partnerközpont API-k használatával

A következőre vonatkozik: Partnerközpont

Nem vonatkozik a 21Vianet által üzemeltetett Partnerközpontra | Partnerközpont a Microsoft Cloud for US Government számára

A Partnerközpont jelenleg csak a Microsoft nyilvános felhőjében támogatja a Microsoft Ügyfélszerződés ügyfél általi elfogadásának megerősítését.

Ez a cikk a Microsoft Ügyfélszerződés ügyfél általi elfogadásának megerősítését vagy ismételt megerősítését ismerteti.

Előfeltételek

  • Ha a Partnerközpont .NET SDK-t használja, az 1.14-es vagy újabb verzióra van szükség.

Fontos

2023 júniusától a partnerközpont .NET SDK legújabb, 3.4.0-s kiadását archiváljuk. Az SDK-kiadást letöltheti a GitHubról, valamint egy hasznos információkat tartalmazó olvasófájlt.

A partnereket arra ösztönzik, hogy továbbra is használják a Partnerközpont REST API-jait.

  • Hitelesítő adatok a Partnerközpont hitelesítésében leírtak szerint. Ez a forgatókönyv csak az App+User hitelesítést támogatja.

  • Ügyfélazonosító (customer-tenant-id). Ha nem ismeri az ügyfél azonosítóját, megkeresheti a Partnerközpontban az Ügyfelek munkaterület kiválasztásával, majd az ügyféllistából, majd a Fiók listában. Az ügyfél Fiók lapján keresse meg a Microsoft-azonosítót az Ügyfélfiók adatai szakaszban. A Microsoft-azonosító megegyezik az ügyfél-azonosítóval (customer-tenant-id).

  • Az a dátum (dátumA megállapodás), amikor az ügyfél elfogadta a Microsoft Ügyfélszerződés.

  • A Microsoft Ügyfélszerződés elfogadó ügyfélszervezet felhasználójának adatai. This includes:

    • First name
    • Last name
    • Email address
    • Telefon szám (nem kötelező)
  • Ha a következő értékek módosulnak egy ügyfél esetében, a Partnerközpont engedélyezi egy másik szerződés létrehozását az adott ügyfél számára: Vezetéknév vezetéknév e-mail-címe Telefon szám Ellenkező esetben a partnerek a következő hibakódot kapják, mert ismétlődő ügyfél jön létre

{
"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

A Microsoft Ügyfélszerződés ügyfél általi elfogadásának megerősítése vagy ismételt megerősítése:

  1. Kérje le a szerződés metaadatait a Microsoft Ügyfélszerződés. Be kell szereznie a Microsoft Ügyfélszerződés sablonazonosítóját. További információ: Szerződés metaadatainak lekérése Microsoft Ügyfélszerződés.

    // IAggregatePartner partnerOperations;
    
    string agreementType = "MicrosoftCustomerAgreement";
    
    var microsoftCustomerAgreementDetails = partnerOperations.AgreementDetails.ByAgreementType(agreementType).Get().Items.Single();
    
  2. Hozzon létre egy új szerződésobjektumot , amely tartalmazza a megerősítés részleteit.

  3. Használja az IAgreggatePartner.Customers gyűjteményt, és hívja meg a ById metódust a megadott ügyfél-bérlő azonosítóval.

  4. Használja a Szerződések tulajdonságot, majd hívja meg a Create vagy a CreateAsync parancsot.

    // 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);
    

A konzoltesztelési alkalmazás projektjének CreateCustomerAgreement osztályában teljes minta található.

REST-kérés

A Microsoft Ügyfélszerződés ügyfél általi elfogadásának megerősítése vagy ismételt megerősítése:

  1. Kérje le a szerződés metaadatait a Microsoft Ügyfélszerződés. Be kell szereznie a Microsoft Ügyfélszerződés sablonazonosítóját. További információ: Szerződés metaadatainak lekérése Microsoft Ügyfélszerződés.

  2. Hozzon létre egy új szerződési erőforrást annak ellenőrzéséhez, hogy az ügyfél elfogadta-e a Microsoft Ügyfélszerződés. Használja az alábbi REST-kérés szintaxisát.

Kérés szintaxisa

Method Kérés URI-ja
POST {baseURL}/v1/customers/{customer-tenant-id}/agreements HTTP/1.1

URI-paraméter

A következő lekérdezési paraméterrel adhatja meg a megerősítendő ügyfelet.

Name Type Kötelező Leírás
ügyfél-bérlő-azonosító GUID Igen Az érték egy GUID formátumú ügyfél-bérlő azonosító, amely egy olyan azonosító, amely lehetővé teszi az ügyfél megadását.

Kérésfejlécek

További információ: Partnerközpont – REST fejlécek.

Kérés törzse

Ez a táblázat a REST-kérelem törzsében található szükséges tulajdonságokat ismerteti.

Name Type Description
Agreement object A partner által megadott adatok a Microsoft Ügyfélszerződés ügyfél általi elfogadásának megerősítéséhez.

Agreement

Ez a táblázat a szerződés-erőforrás létrehozásához minimálisan szükséges mezőket ismerteti.

Tulajdonság Type Description
primaryContact Kapcsolatfelvétel A Microsoft Ügyfélszerződés elfogadó ügyfél szervezetének felhasználójára vonatkozó információk, beleértve a következőket: firstName, lastName, e-mail és phoneNumber (nem kötelező)
dateAgreed sztring UTC dátum időformátumban Az a dátum, amikor az ügyfél elfogadta a szerződést.
templateId sztring Az ügyfél által elfogadott szerződéstípus egyedi azonosítója. A Microsoft Ügyfélszerződés sablonazonosítóját a Microsoft Ügyfélszerződés szerződés metaadatainak lekérésével szerezheti be. Részletekért tekintse meg a Microsoft Ügyfélszerződés szerződés metaadatainak lekérése című témakört.
típus sztring Az ügyfél által elfogadott szerződéstípus. Használja a "MicrosoftCustomerAgreement" kifejezést, ha az ügyfél elfogadta a Microsoft Ügyfélszerződés.

Példa kérése

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: ab993325-1605-4cf4-bac4-fb584142a31b
{
    "primaryContact": {
        "firstName": "Tania",
        "lastName": "Carr",
        "email": "someone@example.com",
        "phoneNumber": "1234567890"
    },
    "templateId": "117a77b0-9360-443b-8795-c6dedc750cf9",
    "dateAgreed": "2018-06-14T00:00:00.000Z",
    "type": "MicrosoftCustomerAgreement"
}

REST-válasz

Ha sikeres, ez a metódus egy szerződési erőforrást ad vissza.

Válasz sikeresség és hibakódok

Minden válaszhoz tartozik egy HTTP-állapotkód, amely jelzi a sikert vagy a hibát, valamint további hibakeresési információkat.

A kód, a hibatípus és a további paraméterek olvasásához használjon hálózati nyomkövetési eszközt. A teljes listát a Partnerközpont REST-hibakódjaiban találja.

Példa válaszra

HTTP/1.1 201 Created
Content-Length: 261
Content-Type: application/json
MS-RequestId: 94e4e214-6b06-4fb7-96d1-94d559f9b47f
MS-CorrelationId: ab993325-1605-4cf4-bac4-fb584142a31b
{
    "userId": "3d6f2c09-eb40-48ca-a4b3-d24c9c007531",
    "primaryContact": {
        "firstName": "Tania",
        "lastName": "Carr",
        "email": "someone@example.com",
        "phoneNumber": "1234567890"
    },
    "templateId": "117a77b0-9360-443b-8795-c6dedc750cf9",
    "dateAgreed": "2018-06-14T00:00:00.000Z",
    "type": "MicrosoftCustomerAgreement"
}