Mise en route de l'API Online Management

Notes

À compter du 26 août 2020, l’API Online Management est déconseillée.

Cette rubrique offre des informations de base pour vous aider à prendre en main l’API Online Admin pour Microsoft Dataverse.

Rôles d'administrateur Microsoft 365

Pour utiliser l'API Online Management, vous devez avoir un des rôles d'administrateur suivants dans votre client Microsoft 365 :

• Administrateur global
• Administrateur de service

Pour plus d’informations sur ces rôles, consultez À propos des rôles d’administrateur

URL du service

L'URL de service définit l'adresse du point de terminaison pour accéder à l'API REST. Pour exécuter toute opération à l'aide de l'API Online Management, vous devez préciser l'URL de requête au format suivant :

{ServiceUrl}/api/v1.2/{resource}

Par exemple, vous pouvez passer dans l’URL suivante avec une demande de type GET pour récupérer les instances dans votre client Microsoft 365 en Amérique du Nord :

https://admin.services.crm.dynamics.com/api/v1.2/instances

Pour une liste d’URL de service, voir URL de service.

En-têtes standard

L'API Online Management a les en-têtes de réponse et de demande standard suivantes.

En-têtes de demande

En-tête	Type	Description
Accepter-Langue	Chaîne	Spécifie la langue par défaut pour la réponse. Pour plus d'informations sur l'en-tête : Accepter-Langue (docs web MDN)
Autorisation	Chaîne	Spécifie les informations d'identification permettant d'authentifier un utilisateur avec le service de l'API d'Online Management. Pour plus d'informations sur l'en-tête : Autorisation (docs web MDN)

Voir S'authentifier pour utiliser l'API Online Management pour en savoir plus sur la configuration de ces en-têtes dans votre demande.

En-têtes de réponse

En-tête	Description
Emplacement-opération	Pour les opérations longues, précise l'emplacement de la requête d'opération pour vérifier son statut. Par exemple : https://admin.services.crm.dynamics.com/operations/{operationid}
Recommencer-Après	Pour les opérations longues, précise la période recommandée en secondes à l'issue de laquelle demander à nouveau le statut de l'opération. Par exemple : 30

Rubriques connexes

S'authentifier pour utiliser l'API Online Management

Opérations prises en charge par l'API Online Management

Référence de l'API Online Management

Notes

Pouvez-vous nous indiquer vos préférences de langue pour la documentation ? Répondez à un court questionnaire. (veuillez noter que ce questionnaire est en anglais)

Le questionnaire vous prendra environ sept minutes. Aucune donnée personnelle n’est collectée (déclaration de confidentialité).