Obtenir la confirmation de l’acceptation du Contrat client Microsoft par le client

Article
03/05/2024

S’applique à : Espace partenaires

Ne s’applique pas à : Espace partenaires géré par 21Vianet | Espace partenaires Microsoft Cloud for US Government

La ressource Contrat est actuellement prise en charge par l’Espace partenaires uniquement dans le cloud public Microsoft.

Cet article explique comment récupérer la ou les confirmations d’acceptation d’un client de la Contrat client Microsoft.

Prérequis

Si vous utilisez le Kit de développement logiciel (SDK) .NET de l’Espace partenaires, la version 1.14 ou ultérieure est requise.

Important

Depuis juin 2023, la dernière version du Kit de développement logiciel (SDK) .NET de l’Espace partenaires version 3.4.0 est désormais archivée. Vous pouvez télécharger la version du SDK à partir de GitHub, ainsi qu’un fichier lisezmoi contenant des informations utiles.

Les partenaires sont encouragés à continuer à utiliser les API REST de l’Espace partenaires.
Informations d’identification, comme décrit dans Authentification auprès de l’Espace partenaires. Ce scénario ne prend en charge que l’authentification de l’application et de l’utilisateur.
ID du client (customer-tenant-id). Si vous ne connaissez pas l’ID du client, vous pouvez le rechercher dans l’Espace de partenaires en sélectionnant l’espace de travail Clients, puis le client dans la liste des clients, puis compte. Dans la page Compte du client, recherchez l’ID Microsoft dans la section Informations sur le compte client. L’ID Microsoft est le même que l’ID de client (customer-tenant-id).

.NET

Pour récupérer la ou les confirmations de l’acceptation du client précédemment fournies :

Utilisez la collection IAggregatePartner.Customers et appelez la méthode ById avec l’identificateur client spécifié.
Récupérez la propriété Agreements et filtrez les résultats sur Contrat client Microsoft en appelant la méthode ByAgreementType.
Appelez la méthode Get ou GetAsync .

// IAggregatePartner partnerOperations;
// string selectedCustomerId;

string agreementType = "MicrosoftCustomerAgreement";

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

Vous trouverez un exemple complet dans la classe GetCustomerAgreements à partir du projet d’application de test console.

Demande REST

Pour récupérer la confirmation de l’acceptation du client précédemment fournie :

Créez une requête REST pour récupérer la collection Contrats pour le client.
Utilisez le paramètre de requête agreementType pour limiter les résultats aux seules Contrat client Microsoft.

Syntaxe de la requête

Utilisez la syntaxe de requête suivante :

Méthode	URI de demande
GET	{baseURL}/v1/customers/{customer-tenant-id}/agreements ?agreementType={agreement-type} HTTP/1.1

Paramètres d’URI

Vous pouvez utiliser les paramètres d’URI suivants avec votre requête :

Nom	Type	Requise	Description
customer-tenant-id	GUID	Oui	La valeur est un GUID mis en forme CustomerTenantId qui vous permet de spécifier un client.
type de contrat	string	Non	Ce paramètre retourne toutes les métadonnées de contrat. Utilisez ce paramètre pour étendre la réponse de requête à un type de contrat spécifique. Les valeurs prises en charge sont les suivantes : MicrosoftCloudAgreement qui inclut uniquement les métadonnées de contrat du type MicrosoftCloudAgreement. MicrosoftCustomerAgreement qui inclut uniquement les métadonnées de contrat du type MicrosoftCustomerAgreement. * qui retourne toutes les métadonnées de contrat. (N’utilisez * pas, sauf si votre code a la logique nécessaire pour gérer les types de contrats inattendus.) Remarque : Si le paramètre URI n’est pas spécifié, la requête est définie par défaut sur MicrosoftCloudAgreement pour la compatibilité descendante. Microsoft peut introduire des métadonnées de contrat avec de nouveaux types de contrats à tout moment.

En-têtes de requête

Pour plus d’informations, consultez En-têtes REST de l’Espace Partenaires.

Corps de la demande

Aucune.

Exemple de requête

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

Réponse REST

Si elle réussit, cette méthode retourne une collection de ressources Agreement dans le corps de la réponse.

Codes d’erreur et de réussite de la réponse

Chaque réponse est fournie avec un code d’état HTTP qui indique la réussite ou l’échec et d’autres informations de débogage.

Utilisez un outil de suivi réseau pour lire ce code, le type d’erreur et d’autres paramètres. Pour obtenir la liste complète, consultez Codes d’erreur REST de l’Espace partenaires.

Exemple de réponse

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"
        }
    ]
}

Partager via