Obtenir un lien de téléchargement pour le modèle de Contrat client Microsoft

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 AgreementDocument est actuellement prise en charge par l’Espace partenaires uniquement dans le cloud public Microsoft.

Cet article explique comment obtenir un lien pour télécharger le modèle Contrat client Microsoft, en fonction du pays/de la région et de la langue du client.

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.
Pays/région du client auquel le modèle de Contrat client Microsoft s’applique.
Langue dans laquelle le modèle Contrat client Microsoft doit être localisé.

Important

Le Contrat client Microsoft est propre au pays/à la région. Lorsque vous demandez un lien pour télécharger le modèle Contrat client Microsoft, veillez à spécifier le pays/région approprié en fonction de l’emplacement du client. ou liste des pays/régions pris en charge, reportez-vous à la liste des pays/régions et langues pris en charge.
Pour certains pays/régions, le Contrat client Microsoft est disponible dans plusieurs langues. Pour une expérience client optimale, choisissez la langue qui correspond le mieux aux besoins du client. Pour obtenir la liste des langues prises en charge, reportez-vous à la liste des pays/régions et langues pris en charge.
Cette méthode n’est prise en charge que par le Contrat client Microsoft.

.NET

Pour récupérer un lien pour télécharger le modèle Contrat client Microsoft :

Récupérez les métadonnées du Contrat client Microsoft. Vous devez obtenir la valeur templateId du Contrat client Microsoft. Pour plus d’informations, consultez Obtenir les métadonnées du Contrat client Microsoft.

// IAggregatePartner partnerOperations;

string agreementType = "MicrosoftCustomerAgreement";

AgreementMetaData microsoftCustomerAgreementDetails = partnerOperations.AgreementDetails.   ByAgreementType(agreementType).Get().Items.Single();

Utilisez la collection IAggregatePartner.AgreementTemplates.
Appelez la méthode ById et spécifiez le templateId du Contrat client Microsoft.
Récupérez la propriété Document .
Appelez la méthode ByCountry et spécifiez le pays/la région du client auquel le modèle de contrat s’applique. La requête est définie par défaut aux États-Unis si la méthode n’est pas spécifiée. Pour obtenir la liste des codes pays/régions pris en charge, reportez-vous à la liste des pays/régions et langues pris en charge. Cette méthode respecte la casse.
Appelez la méthode ByLanguage et spécifiez la langue dans laquelle le modèle de contrat doit être localisé. La requête est définie par défaut sur en-US si la méthode n’est pas spécifiée ou si le code pays/région spécifié n’est pas pris en charge pour le pays/la région spécifié. Pour obtenir la liste des codes de langue pris en charge, reportez-vous à la liste des pays/régions et langues pris en charge.

Appelez la méthode Get ou GetAsync .

// IAggregatePartner partnerOperations;

string customerCountry = "US";

string languageForLocalization = "en-US";

var agreementDocument = partnerOperations.   AgreementTemplates.ById   (microsoftCustomerAgreementDetails.   TemplateId).Document.ByCountry   (customerCountry).ByLanguage   (languageForLocalization).Get();

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

Demande REST

Pour récupérer un lien pour télécharger le modèle Contrat client Microsoft :

Récupérez les métadonnées du Contrat client Microsoft. Vous devez obtenir la valeur templateId du Contrat client Microsoft. Pour plus d’informations, consultez Obtenir les métadonnées du Contrat client Microsoft.
Créez une requête REST pour récupérer une ressource AgreementDocument. Pour obtenir un exemple, consultez l’exemple de syntaxe de requête. Vous devez spécifier les informations suivantes :
- TemplateId du Contrat client Microsoft
- Pays/région auquel le modèle de Contrat client Microsoft s’applique
- Langue dans laquelle le modèle Contrat client Microsoft doit être localisé

Syntaxe de la requête

Utilisez la syntaxe de requête suivante pour cette ressource :

Méthode	URI de demande
GET	{baseURL}/v1/agreementtemplates/{agreement-template-id}/document ?language={language}&country={country} HTTP/1.1

Paramètres d’URI

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

Nom	Type	Requise	Description
agreement-template-id	string	Oui	Identificateur unique du type de contrat. Vous pouvez obtenir la valeur de templateId du Contrat client Microsoft en récupérant les métadonnées du Contrat client Microsoft. Pour plus d’informations, consultez Obtenir les métadonnées du Contrat client Microsoft. Ce paramètre respecte la casse.
country	string	Non	Indique le pays/la région auquel le modèle de contrat s’applique. La requête est définie par défaut aux États-Unis si le paramètre n’est pas spécifié. Pour obtenir la liste des codes pays/régions pris en charge, reportez-vous à la liste des pays/régions et langues pris en charge.
langue	string	Non	Indique la langue dans laquelle le modèle de contrat doit être localisé. La requête est définie par défaut sur en-US si le paramètre n’est pas spécifié ou si le code pays/région spécifié n’est pas pris en charge pour le pays/la région spécifié. Pour obtenir la liste des codes pays/régions pris en charge, reportez-vous à la liste des pays/régions et langues pris en charge.

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/agreementtemplates/117a77b0-9360-443b-8795-c6dedc750cf9/document?language=en-US&country=US 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 renvoie une ressource AgreementDocument dans le corps de la réponse.

La ressource a une propriété downloadUri , qui contient une chaîne d’URL qui peut être utilisée pour télécharger le modèle de contrat. Un lien différent est retourné chaque fois que vous effectuez une requête. Ce lien expire après cinq minutes.

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
{
    "displayUri":"https://wopihost.int.l2o.microsoft.com/v1/officehost/agreement/files/Preview...",
    "downloadUri":"https://l2oagreementintbn2.blob.core.windows.net/agreementscontainer/Preview...",
    "language":"en-US",
    "country":"US"
}

Liste des pays/régions et langues pris en charge