Show Menu
SUJETS×

Guide du développeur d’API Sandbox

Les sandbox d’Adobe Experience Platform fournissent des environnements de développement isolés qui vous permettent de tester des fonctionnalités, d’exécuter des expériences et de créer des configurations personnalisées sans affecter votre environnement de production.
Ce guide du développeur décrit les étapes à suivre pour vous aider à utiliser l’API Sandbox pour gérer les sandbox dans la plate-forme d’expérience et inclut des exemples d’appels d’API pour effectuer diverses opérations.

Prise en main de l’API Sandbox

Pour gérer les sandbox pour votre organisation IMS, vous devez disposer des autorisations d’administration Sandbox. Les utilisateurs sans autorisation d’accès ne peuvent utiliser que le point de terminaison pour répertorier les sandbox actifs pour l’utilisateur actuel. Pour plus d’informations sur l’attribution d’autorisations de sandbox pour la plateforme d’expérience, consultez la présentation du contrôle d'accès.

Lecture des exemples d’appels d’API

Ce guide fournit des exemples d’appels d’API pour montrer comment formater vos requêtes. Il s’agit notamment des chemins d’accès, des en-têtes requis et des charges de requête correctement formatées. L’exemple JSON renvoyé dans les réponses de l’API est également fourni. Pour plus d’informations sur les conventions utilisées dans la documentation pour les exemples d’appels d’API, voir la section sur la façon de lire des exemples d’appels d’API dans le guide de dépannage d’Experience Platform.

Rassembler les valeurs des en-têtes requis

Ce guide vous demande d'avoir suivi le didacticiel d' authentification pour pouvoir invoquer les API de plate-forme. Le didacticiel d’authentification fournit les valeurs de chacun des en-têtes requis dans tous les appels d’API de plateforme d’expérience, comme indiqué ci-dessous :
  • Autorisation : Porteur {ACCESS_TOKEN}
  • x-api-key : {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}
Outre les en-têtes d’authentification, toutes les requêtes nécessitent un en-tête spécifiant le nom du sandbox dans lequel l’opération aura lieu :
  • x-sandbox-name : {SANDBOX_NAME}
Toutes les requêtes qui contiennent une charge utile (POST, PUT et PATCH) nécessitent un en-tête supplémentaire :
  • Content-Type : application/json

Étapes suivantes

Maintenant que vous avez rassemblé les informations d’identification requises, vous pouvez continuer à lire le reste du guide du développeur. Chaque section fournit des informations importantes sur leurs points de terminaison et présente des exemples d’appels d’API pour effectuer des opérations CRUD. Chaque appel comprend le format général de l’ API, un exemple de requête présentant les en-têtes requis et les charges utiles correctement formatées, ainsi qu’un exemple de réponse pour un appel réussi.