Récupération d’une configuration d’informations d’identification

Cette page illustre la requête d’API et la payload que vous pouvez utiliser pour récupérer une configuration d’informations d’identification à l’aide du point d’entrée /authoring/credentials de l’API.

Quand utiliser le point d’entrée de l’API /credentials when-to-use

Utilisez ce point d’entrée de l’API pour créer une configuration d’informations d’identification uniquement s’il existe un système d’authentification global entre Adobe et votre plateforme de destination et si le client Experience Platform n’a pas besoin de fournir d’informations d’authentification pour se connecter à la destination. Dans ce cas, vous devez créer une configuration d’informations d’identification à l’aide du point d’entrée /credentials de l’API.

Lors de l’utilisation d’un système d’authentification global, vous devez définir les "authenticationRule":"PLATFORM_AUTHENTICATION" dans la configuration diffusion de destination lors de la création d’une configuration de destination. Ensuite, vous devez créer une configuration des informations d’identification et transmettre l’identifiant de l’objet d’identification dans le paramètre authenticationId de la configuration diffusion de destination.

Prise en main des opérations de l’API des informations d’identification get-started

Avant de poursuivre, consultez le guide de prise en main pour obtenir des informations importantes à connaître avant d’effectuer des appels vers l’API, notamment sur la manière d’obtenir l’autorisation de création de la destination et les en-têtes obligatoires.

Récupération d’une configuration d’informations d’identification retrieve

Vous pouvez récupérer une configuration d’informations d’identification existante en effectuant une requête GET au point dʼentrée /authoring/credentials.

Format d’API

Utilisez le format d’API suivant pour récupérer toutes les configurations d’informations d’identification pour votre compte.

GET /authoring/credentials

Utilisez le format d’API suivant pour récupérer une configuration d’informations d’identification spécifique, définie par le paramètre {INSTANCE_ID}.

GET /authoring/credentials/{INSTANCE_ID}

Les deux requêtes suivantes récupèrent toutes les configurations d’informations d’identification pour votre organisation IMS ou une configuration d’informations d’identification spécifique, selon que vous transmettez ou non le paramètre INSTANCE_ID dans la requête.

Sélectionnez chaque onglet ci-dessous pour afficher la payload correspondante.

curl -X GET https://platform.adobe.io/data/core/activation/authoring/credentials \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \

{
   "instanceId":"n55affa0-3747-4030-895d-1d1236bb3680",
   "createdDate":"2021-06-07T06:41:48.641943Z",
   "lastModifiedDate":"2021-06-07T06:41:48.641943Z",
   "type":"s3Authentication",
   "name":"yourdestination",
   "s3Authentication":{
      "accessId":"string",
      "secretKey":"string"
   }
},
{
   "instanceId":"a25bffa0-3127-4030-895d-1d1236bb3680",
   "createdDate":"2022-06-07T06:41:48.641943Z",
   "lastModifiedDate":"2022-08-07T06:41:48.641943Z",
   "type":"basic",
   "name":"yourdestination",
   "s3Authentication":{
      "url":"string",
      "username":"string",
      "password":"string"
   }
}

curl -X GET https://platform.adobe.io/data/core/activation/authoring/credentials/{INSTANCE_ID} \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

{
   "instanceId":"n55affa0-3747-4030-895d-1d1236bb3680",
   "createdDate":"2021-06-07T06:41:48.641943Z",
   "lastModifiedDate":"2021-06-07T06:41:48.641943Z",
   "type":"s3Authentication",
   "name":"yourdestination",
   "s3Authentication":{
      "accessId":"string",
      "secretKey":"string"
   }
}

Gestion des erreurs d’API error-handling

Les points d’entrée de l’API Destination SDK suivent les principes généraux des messages d’erreur de l’API Experience Platform. Consultez les sections Codes d’état API et Erreurs d’en-tête de requête dans le guide de dépannage d’Experience Platform.

Étapes suivantes next-steps

Vous êtes arrivé au bout de ce document. À présent, vous savez comment récupérer des détails sur la configuration de vos informations d’identification à l’aide du point d’entrée /authoring/credentials de l’API. Consultez la documentation Comment utiliser Destination SDK pour configurer la destination afin de comprendre la place de cette étape dans le processus de configuration de la destination.