Concept : API REST Adaptive Planning

Un client utilise 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 en cours d'utilisation. La version actuelle de l'API Adaptive Planning est v40. Si votre instance utilise l'authentification régionale et non basée sur les États-Unis, les URL d'autorisation et les points de terminaison de l'API varient selon la région. Voir Référence : URL d'authentification régionale.

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 une nouvelle version des API. Workday prend en charge la version actuelle pendant au moins un an après la publication de la version API suivante.

Pour obtenir un historique des modifications d'API, voir Modifications des API par version.

La demande HTTP POST contient des données POST dans un document XML. Ce document XML comprend des sections standard figurant dans chaque appel de méthode API et des sections spécifiques de chaque appel de méthode API. Le serveur Adaptive Planning traite l'appel de méthode API et renvoie les résultats sous la forme d'un autre document XML. Comme pour la demande, le document XML de réponse inclut des sections identiques pour chaque méthode API et des sections spécifiques de chaque méthode API.

Toutes les données de récupération utilisent une recherche. L'appelant indique des critères pour mettre en correspondance un nombre d'éléments et le serveur répond avec une liste d'entités de métadonnées ou de données qui correspondent aux critères. La création et la mise à jour des données utilisent un téléchargement en bloc de données, également soumises via une instruction POST.

Toutes les demandes API sont chiffrées, car elles doivent utiliser le protocole web HTTPS. Les identifiants d'authentification de l'utilisateur sont transmis à Adaptive Planning dans le cadre de la demande de services web. Cela 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 doit authentifier son utilisateur séparément.

De plus, les méthodes de service web limitent la sortie de chaque appel au jeu 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 sur les périmètres appartenant à l'utilisateur appelant.