Show Menu
SUJETS×

FAQ sur la plate-forme et guide de dépannage

Ce document fournit des réponses aux questions fréquentes sur Adobe Experience Platform, ainsi qu’un guide de dépannage de haut niveau pour les erreurs courantes qui peuvent se produire dans toute API Experience Platform. Pour obtenir des guides de dépannage sur les services de plateforme individuels, voir le répertoire de dépannage des services ci-dessous.

FAQ

Vous trouverez ci-dessous une liste de réponses aux questions fréquentes sur Adobe Experience Platform.

Que sont les API de plateforme d’expérience ?

Experience Platform offre plusieurs API RESTful qui utilisent des requêtes HTTP pour accéder aux ressources de la plate-forme. Ces API de service exposent chacun plusieurs points de terminaison et vous permettent d’effectuer des opérations sur des ressources de liste (GET), de recherche (GET), de modification (PUT et/ou PATCH) et de suppression (DELETE). Pour plus d’informations sur les points de terminaison et les opérations spécifiques disponibles pour chaque service, consultez la documentation de référence des API sur les E/S Adobe.

Comment formater une demande d’API ?

Les formats de requête varient en fonction de l’API de plateforme utilisée. Le meilleur moyen d’apprendre à structurer vos appels d’API est de suivre les exemples fournis dans la documentation du service de plateforme particulier que vous utilisez.

Exemples d’appels d’API lus

La documentation relative à la plate-forme d’expérience présente des exemples d’appels d’API de deux manières différentes. Tout d’abord, l’appel est présenté dans son format d’ API, une représentation de modèle montrant uniquement l’opération (GET, POST, PUT, PATCH, DELETE) et le point de terminaison utilisé (par exemple, /global/classes ). Certains modèles indiquent également l’emplacement des variables pour illustrer comment un appel doit être formulé, par exemple GET /{VARIABLE}/classes/{ANOTHER_VARIABLE} .
Les appels sont ensuite affichés sous forme de commandes cURL dans une requête , qui comprend les en-têtes nécessaires et le "chemin de base" complet nécessaires pour interagir avec l’API. Le chemin de base doit être préfixé à tous les points de terminaison. Par exemple, le /global/classes point de terminaison susmentionné devient https://platform.adobe.io/data/foundation/schemaregistry/global/classes . Le format d’API / modèle de requête est visible dans toute la documentation et vous devez utiliser le chemin d’accès complet illustré dans l’exemple Request lorsque vous effectuez vos propres appels aux API de plateforme.

Exemple de demande d’API

Voici un exemple de demande d’API qui illustre le format que vous allez rencontrer dans la documentation.
Format d’API
Le format d’API affiche l’opération (GET) et le point de terminaison utilisé. Les variables sont indiquées par des accolades (dans ce cas, {CONTAINER_ID} ).
GET /{CONTAINER_ID}/classes

Requête
Dans cet exemple de requête, les variables du format API reçoivent des valeurs réelles dans le chemin de la requête. Tous les en-têtes requis sont également affichés, sous forme d’exemples de valeurs d’en-tête ou de variables dans lesquels des informations sensibles (telles que des jetons de sécurité et des ID d’accès) doivent être incluses.
curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/global/classes \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse
La réponse illustre ce que vous prévoyez de recevoir après un appel réussi à l’API, en fonction de la demande qui a été envoyée. Parfois, la réponse est tronquée pour l’espace, ce qui signifie que vous pouvez voir plus d’informations ou d’informations supplémentaires sur celles qui sont affichées dans l’exemple.
{
    "results": [
        {
            "title": "XDM ExperienceEvent",
            "$id": "https://ns.adobe.com/xdm/context/experienceevent",
            "meta:altId": "_xdm.context.experienceevent",
            "version": "1"
        },
        {
            "title": "XDM Individual Profile",
            "$id": "https://ns.adobe.com/xdm/context/profile",
            "meta:altId": "_xdm.context.profile",
            "version": "1"
        }
    ],
    "_links": {}
}

Pour plus d'informations sur des points de terminaison spécifiques dans les API de plateformes, y compris les en-têtes et les corps de requêtes requis, consultez la documentation de référence des API.

Quelle est mon organisation IMS ?

Une organisation IMS est une représentation Adobe d’un client. Toutes les solutions Adobe sous licence sont intégrées à cette société cliente. Lorsqu’une organisation IMS a le droit d’accéder à la plate-forme d’expérience, elle peut attribuer un accès aux développeurs. L’ID d’organisation IMS ( x-gw-ims-org-id ) représente l’organisation pour laquelle un appel d’API doit être exécuté et est donc requis comme en-tête dans toutes les demandes d’API. Cet identifiant est accessible via la Console développeur Adobe : dans l’onglet Intégrations , accédez à la section Aperçu pour une intégration particulière afin de trouver l’identifiant sous Informations d’identification du client. Pour une présentation détaillée de la procédure d’authentification dans la plate-forme, consultez le didacticiel d’ authentification.

Où puis-je trouver ma clé d'API ?

Une clé d'API est requise en tant qu'en-tête dans toutes les requêtes d'API. Il est accessible via la Console développeur Adobe . Dans la console, dans l’onglet Intégrations , accédez à la section Aperçu pour une intégration spécifique et vous trouverez la clé sous Informations d’identification du client. Pour une présentation détaillée de la procédure d’authentification sur la plate-forme, consultez le didacticiel d’ authentification.

Comment puis-je obtenir un jeton d'accès ?

Les Jetons d'accès sont requis dans l'en-tête Autorisation de tous les appels d'API. Ils peuvent être générés à l’aide d’une curl commande, à condition que vous ayez accès à une intégration pour une organisation IMS. Les Jetons d'accès ne sont valides que pendant 24 heures, après quoi un nouveau jeton doit être généré pour continuer à utiliser l’API. Pour plus d'informations sur la génération de jetons d'accès, consultez le didacticiel sur l' authentification.

Comment utiliser les paramètres de requête ?

Certains points de terminaison de l'API de plateforme acceptent des paramètres de requête pour localiser des informations spécifiques et filtrer les résultats renvoyés dans la réponse. Les paramètres de Requête sont ajoutés aux chemins de requête avec un point d’interrogation ( ? ), suivi d’un ou plusieurs paramètres de requête utilisant le format paramName=paramValue . Lorsque vous combinez plusieurs paramètres dans un seul appel, vous devez utiliser une esperluette ( & ) pour séparer des paramètres individuels. L’exemple suivant montre comment une requête utilisant plusieurs paramètres de requête est représentée dans la documentation.
Voici quelques exemples de paramètres de requête couramment utilisés :
GET /tenant/schemas?orderby=title
GET /datasets?limit=36&start=10
GET /batches?createdAfter=1559775880000&orderBy=desc:created

Pour obtenir des informations détaillées sur les paramètres de requête disponibles pour un service ou un point de terminaison spécifique, consultez la documentation spécifique au service.

Comment puis-je indiquer un champ JSON à mettre à jour dans une requête PATCH ?

De nombreuses opérations PATCH dans les API de plateformes utilisent des chaînes de pointeur rfc6901 JSON pour indiquer les propriétés JSON à mettre à jour. Elles sont généralement incluses dans les charges utiles de requête au format Patch rfc6902 JSON. Pour obtenir des informations détaillées sur la syntaxe requise pour ces technologies, reportez-vous au guide Concepts fondamentaux de l’API Adobe Experience Platform API fundamentals guide.

Puis-je utiliser Postman pour appeler les API de plateformes ?

Postman est un outil utile pour visualiser les appels aux API RESTful. Cette publication using-postman-for-jwt-authentication-on-adobe-i-o-7573428ffe7f moyenne décrit comment configurer Postman pour effectuer automatiquement l’authentification et l’utiliser pour utiliser les API de plateforme d’expérience.

Quelle est la configuration système requise pour Platform ?

Selon que vous utilisez l’interface utilisateur ou l’API, la configuration système requise suivante s’applique :
Pour les opérations basées sur l’interface utilisateur :
  • Un navigateur Web moderne et standard. Bien que la dernière version de Chrome soit recommandée, les versions majeures actuelles et précédentes de Firefox, Internet Explorer et Safari sont également prises en charge.
    • Chaque fois qu'une nouvelle version majeure est publiée, les débuts de plateformes prenant en charge la version la plus récente tandis que la prise en charge de la troisième version la plus récente est supprimée.
  • Les cookies et JavaScript doivent être activés dans tous les navigateurs.
Pour les interactions API et développeurs :
  • environnement de développement à développer pour les intégrations REST, streaming et Webhook.

Erreurs et dépannage

Voici une liste d’erreurs que vous pouvez rencontrer lors de l’utilisation d’un service Experience Platform. Pour obtenir des guides de dépannage sur les services de plateforme individuels, voir le répertoire de dépannage des services ci-dessous.

Codes d’état d’API

Les codes d’état suivants peuvent être rencontrés sur toute API de plateforme d’expérience. Chacun a une variété de causes, donc les explications données dans cette section sont de nature générale. Pour plus d’informations sur les erreurs spécifiques dans les services de plateforme individuels, consultez le répertoire de dépannage des services ci-dessous.
Code de statut
Description
Causes possibles
400
Requête incorrecte
La requête a été mal construite, les informations de clé manquantes et/ou contenait une syntaxe incorrecte.
401
Échec de l'authentification
La demande n'a pas réussi une vérification d'authentification. Votre jeton d'accès est peut-être absent ou non valide. Pour plus d’informations, voir la section Erreurs de jeton OAuth ci-dessous.
403
Interdit
La ressource a été trouvée, mais vous ne disposez pas des informations d'identification appropriées pour la vue.
404
Non trouvé
Impossible de trouver la ressource demandée sur le serveur. La ressource a peut-être été supprimée ou le chemin d'accès demandé a été saisi incorrectement.
500
Erreur interne du serveur
Il s’agit d’une erreur côté serveur. Si vous effectuez de nombreux appels simultanés, il se peut que vous atteigniez la limite de l’API et que vous deviez filtrer vos résultats. (Voir le sous-guide du développeur d’API Catalog Service sur le filtrage des données pour en savoir plus.) Patientez quelques instants avant de réessayer votre requête et contactez votre administrateur si le problème persiste.

Erreurs d’en-tête de demande

Tous les appels d’API dans la plate-forme nécessitent des en-têtes de requête spécifiques. Pour savoir quels en-têtes sont requis pour les services individuels, consultez la documentation de référence des API. Pour trouver les valeurs des en-têtes d’authentification requis, consultez le didacticiel Authentification et accès aux API des plateformes d’expérience Authentification. Si l'un de ces en-têtes est absent ou non valide lors d'un appel d'API, les erreurs suivantes peuvent se produire.

Jeton OAuth manquant

{
    "error_code": "403010",
    "message": "Oauth token is missing."
}

Ce message d’erreur s’affiche lorsqu’un Authorization en-tête est absent d’une requête d’API. Assurez-vous que l’en-tête Autorisation est inclus avec un jeton d'accès valide avant de réessayer.

Jeton OAuth non valide

{
    "error_code": "401013",
    "message": "Oauth token is not valid"
}

Ce message d’erreur s’affiche lorsque le jeton d'accès fourni dans l’ Authorization en-tête n’est pas valide. Assurez-vous que le jeton a été saisi correctement ou générez un nouveau jeton dans la console d’E/S Adobe.

La clé d'API est requise

{
    "error_code": "403000",
    "message": "Api Key is required"
}

Ce message d’erreur s’affiche lorsqu’un en-tête de clé d’API ( x-api-key ) est absent d’une requête d’API. Assurez-vous que l’en-tête est inclus avec une clé d’API valide avant de réessayer.

La clé d'API n'est pas valide

{
    "error_code": "403003",
    "message": "Api Key is invalid"
}

Ce message d’erreur s’affiche lorsque la valeur de l’en-tête de clé d’API fourni ( x-api-key ) n’est pas valide. Vérifiez que vous avez saisi la clé correctement avant de réessayer. Si vous ne connaissez pas votre clé d’API, vous pouvez la trouver dans la console d’E/S Adobe : dans l’onglet Intégrations , accédez à la section Aperçu pour une intégration spécifique afin de trouver la clé d’API sous Informations d’identification du client.

En-tête manquant

{
    "error_code": "400003",
    "message": "Missing header"
}

Ce message d’erreur s’affiche lorsqu’un en-tête d’organisation IMS ( x-gw-ims-org-id ) est absent d’une requête d’API. Assurez-vous que l’en-tête est inclus avec l’ID de votre organisation IMS avant de réessayer.

Profil non valide

{
    "error_code": "403025",
    "message": "Profile is not valid"
}

Ce message d’erreur s’affiche lorsque l’utilisateur ou l’intégration d’E/S Adobe (identifiée par le jeton d'accès dans l’ Authorization en-tête) n’est pas autorisé à invoquer les API de plateforme d’expérience pour l’organisation IMS fournie dans l’ x-gw-ims-org-id en-tête. Assurez-vous d’avoir fourni l’ID correct pour votre organisation IMS dans l’en-tête avant de réessayer. Si vous ne connaissez pas votre ID d’organisation, vous pouvez le trouver dans la console d’E/S Adobe : dans l’onglet Intégrations , accédez à la section Aperçu pour une intégration spécifique afin de trouver l’identifiant sous Informations d’identification du client.

Type de contenu valide non spécifié

{
    "type": "/placeholder/type/uri",
    "status": 400,
    "title": "BadRequestError",
    "detail": "A valid content-type must be specified"
}

Ce message d’erreur s’affiche lorsqu’une requête POST, PUT ou PATCH comporte un en-tête non valide ou manquant. Content-Type Assurez-vous que l’en-tête est inclus dans la requête et que sa valeur est application/json indiquée.

Répertoire de dépannage du service

Voici une liste de guides de dépannage et de documentation de référence d’API pour les API de plateforme d’expérience. Chaque guide de dépannage fournit des réponses aux questions fréquentes et des solutions aux problèmes spécifiques à chaque service de plateforme. Les documents de référence d’API fournissent un guide complet de tous les points de terminaison disponibles pour chaque service et montrent des exemples de corps de requêtes, de réponses et de codes d’erreur que vous pouvez recevoir.
Service
Référence d’API
Résolution des problèmes
Contrôle d'accès
Catalog (Catalogue)
Ingestion des données (lot)
Ingestion des données (diffusion en continu)
Espace de travail Data Science
Étiquetage et application de l’utilisation des données (DULE)
Modèle de données d’expérience (XDM)
Identity Service
Requête Service
Profil client en temps réel
Environnements de test
Segmentation