DocumentationExperience PlatformDocumentation de l’API du serveur réseau Edge

Authentification authentication

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Rubriques :

Créé pour :

  • Développeur

Vue d’ensemble

Le Edge Network Server API gère la collecte de données authentifiées et non authentifiées, en fonction de la source des événements et du domaine de collecte de l’API.

Pour chaque requête, le Server API vérifie le paramètre de la chaîne de données access type. Grâce à ce paramètre, les clients peuvent configurer un flux de données pour accepter les données authentifiées ou les données authentifiées et non authentifiées. Par défaut, les deux types de données sont acceptés.

Pour plus d’informations sur la configuration du type d’accès du flux de données, consultez la documentation sur la création et la configuration d’un flux de données 1}.

Vous trouverez ci-dessous un résumé du comportement, basé sur la configuration de la chaîne de données Access Type et le point de terminaison sur lequel la requête est reçue.

Access Type
edge.adobedc.net
server.adobedc.net
mixte (par défaut)
N’authentifie pas la requête
Authentifie la requête
authentifié
Authentifie la requête
Authentifie la requête

Les appels d’API provenant d’un serveur privé sur server.adobedc.net doivent toujours être authentifiés.

Conditions préalables prerequisites

Avant de pouvoir effectuer des appels vers le Server API, assurez-vous de respecter les conditions préalables suivantes :

  • Vous disposez d’un compte d’organisation ayant accès à Adobe Experience Platform.
  • Les rôles developer et user sont activés pour votre compte d’Experience Platform pour le profil de produit de l’API Adobe Experience Platform. Contactez votre administrateur Admin Console pour activer ces rôles pour votre compte.
  • Vous avez une Adobe ID. Si vous ne possédez pas d’Adobe ID, accédez à Adobe Developer Console et créez un compte.

Collecte des informations d’identification credentials

Pour lancer des appels aux API Platform, vous devez d’abord suivre le tutoriel sur l’authentification. Le tutoriel sur l’authentification indique les valeurs de chacun des en-têtes requis dans tous les appels API Experience Platform, comme illustré ci-dessous :

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key : {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

Les ressources d’Experience Platform peuvent être isolées dans des sandbox virtuels spécifiques. Dans les requêtes aux API Platform, vous pouvez spécifier le nom et l’identifiant du sandbox dans lequel l’opération aura lieu. Il s’agit de paramètres facultatifs.

  • x-sandbox-name: {SANDBOX_NAME}
NOTE
Pour plus d’informations sur les sandbox dans Experience Platform, consultez la documentation de présentation des sandbox.

Toutes les requêtes qui contiennent un payload (POST, PUT, PATCH) nécessitent un en-tête de type de média supplémentaire :

  • Content-Type: application/json

Configuration des autorisations d’écriture de jeux de données dataset-write-permissions

Pour configurer les autorisations d’écriture de jeux de données, accédez à l’Admin Console, recherchez le profil de produit associé à votre clé API et définissez les autorisations suivantes :

  • Dans la section Sandbox , sélectionnez l’environnement de test de la chaîne de données.
  • Dans la section Data Management , sélectionnez l’autorisation Gérer les jeux de données .

Dépannage des erreurs d’autorisation troubleshooting-authorization

Code d’erreur
Message d’erreur
Description
EXEG-0500-401
Jeton d’autorisation non valide

Ce message d'erreur s'affiche dans l'une des situations suivantes :

  • La valeur d’en-tête authorization est manquante.
  • La valeur d’en-tête authorization n’inclut pas le jeton Bearer requis.
  • Le format du jeton d’autorisation fourni n’est pas valide.
  • Le flux de données nécessite une authentification, mais les en-têtes requis ne sont pas présents dans la requête.
EXEG-0501-401
Jeton d’autorisation d’utilisateur non valide

Ce message d'erreur s'affiche dans l'une des situations suivantes :

  • L’en-tête x-user-token requis est absent de l’appel API.
  • Le format du jeton utilisateur fourni n’est pas valide.
EXEG-0502-401
Jeton d’autorisation non valide
Ce message d’erreur s’affiche lorsque le jeton d’autorisation fourni a un format valide (JWT), mais que sa signature n’est pas valide. Consultez le tutoriel d’authentification pour apprendre à obtenir un jeton JWT valide.
EXEG-0503-401
Jeton d’autorisation non valide
Ce message d’erreur s’affiche lorsque le jeton d’autorisation fourni a expiré. Suivez le tutoriel d’authentification pour générer un nouveau jeton.
EXEG-0504-401
Le contexte de produit requis est manquant.

Ce message d'erreur s'affiche dans l'une des situations suivantes :

  • Le compte de développeur n’a pas accès au contexte du produit Adobe Experience Platform.
  • Le compte de la société n’est pas encore autorisé à Adobe Experience Platform.
EXEG-0505-401
La portée du jeton d’autorisation obligatoire est absente.
Cette erreur s’applique uniquement à l’authentification du compte de service. Le message d’erreur s’affiche lorsque le jeton d’autorisation de service inclus dans l’appel appartient à un compte de service qui n’a pas accès à la portée IMS acp.foundation.
EXEG-0506-401
Sandbox non accessible en écriture
Ce message d’erreur s’affiche lorsque le compte de développeur n’a pas l’accès WRITE à l’environnement de test Experience Platform dans lequel le flux de données est défini.
recommendation-more-help
f36c2cef-1417-40aa-a11d-5d0abaee121b