Concept : API REST Adaptive Planning

Un client invoque un appel API en envoyant une demande HTTP POST au point de terminaison principal des services Web Adaptive Planning. Le point de terminaison inclut un numéro de version qui indique la version de l’API utilisée. La version actuelle de l'API Adaptive Planning est la v40. Si votre instance utilise une authentification régionale qui n’est pas fondée sur les États-Unis, vos adresses URL d’autorisation et vos points de terminaison d’API varient selon les régions. Voir : Référence : URL d’authentification régionales.

Les versions d’API sont généralement mises à jour avec les nouvelles versions des produits Adaptive Planning, mais toutes les versions de produits n’entraînent pas de nouvelle version d’API. Workday prend en charge la version actuelle pendant au moins un an après le lancement de la version API ultérieure.

Pour obtenir l’historique des changements apportés à l’API, voir Changements apportés à l'API par version.

La demande HTTP POST contient des données de publication dans un document XML. Ce document XML comprend des sections standard présentes dans chaque appel de méthode API et des sections propres à chaque appel de méthode API. Le serveur Adaptive Planning traite l’appel de la méthode API et renvoie les résultats sous la forme d’un autre document XML. Tout comme la demande, le document XML de réponse comprend des sections qui sont identiques pour chaque méthode API et des sections propres à chaque méthode API.

Toute récupération de données utilise une recherche. L’appelant précise des critères pour mettre en correspondance un nombre d’éléments, et le serveur répond avec une liste d’entités ou de données de métadonnées qui correspondent aux critères. La création et la mise à jour des données utilisent un téléversement en bloc de données, également soumis au moyen d’une directive POST.

Toutes les demandes d’API sont chiffrées, car elles doivent utiliser le protocole Web HTTPS. Les données d'identification de l'utilisateur sont transmises à Adaptive Planning dans le cadre de la demande de services Web. Ce qui signifie que la couche Web chiffre l’identifiant de connexion et le mot de passe d’un utilisateur avant qu’il ne quitte l’ordinateur générant la demande de services Web et ne déchiffre que lorsque le serveur cible les reçoit.

L’authentification d’un utilisateur dans une demande API ne crée pas de session persistante pour cet utilisateur; chaque appel de service Web distinct doit authentifier son utilisateur séparément.

De plus, les méthodes de service Web limitent la sortie de chaque appel à l’ensemble de données visible par l’utilisateur qui fait la demande. Exemple : la méthode de service Web exportData limite les données renvoyées aux données trouvées dans les niveaux qui sont propres à l’utilisateur qui demande.