Mise à jour d’une configuration d’informations d’identification

Cette page illustre la requête d’API et la payload que vous pouvez utiliser pour mettre à jour une configuration d’informations d’identification existante à 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.

Mise à jour d’une configuration d’informations d’identification update

Vous pouvez mettre à jour une configuration d’informations d’identification existante en effectuant une requête PUT au point d’entrée /authoring/credentials avec la payload mise à jour.

Pour obtenir une configuration d’informations d’identification existante et son {INSTANCE_ID} correspondant, consultez l’article sur la récupération d’une configuration d’informations d’identification.

Format d’API

PUT /authoring/credentials/{INSTANCE_ID}

Les requêtes suivantes mettent à jour des configurations d’informations d’identification, définies par les paramètres fournis dans la payload.

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

curl -X PUT https://platform.adobe.io/data/core/activation/authoring/credentials/{INSTANCE_ID} \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
    "basicAuthentication":{
      "url":"string",
      "username":"string",
      "password":"string"
   }
}

curl -X PUT https://platform.adobe.io/data/core/activation/authoring/credentials/{INSTANCE_ID} \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
   "s3Authentication":{
      "accessId":"string",
      "secretKey":"string"
   }
}

curl -X PUT https://platform.adobe.io/data/core/activation/authoring/credentials/{INSTANCE_ID} \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
    "sshAuthentication":{
      "username":"string",
      "sshKey":"string"
   }
}

curl -X PUT https://platform.adobe.io/data/core/activation/authoring/credentials/{INSTANCE_ID} \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
    "azureAuthentication":{
      "url":"string",
      "tenant":"string",
      "servicePrincipalId":"string",
      "servicePrincipalKey":"string"
   }
}

curl -X PUT https://platform.adobe.io/data/core/activation/authoring/credentials/{INSTANCE_ID} \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
    "azureConnectionStringAuthentication":{
      "connectionString":"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 mettre à jour une configuration d’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.