Mise à jour d’une configuration de serveur de destination

Cette page illustre la requête d’API et la payload que vous pouvez utiliser pour mettre à jour une configuration de serveur de destination existante à l’aide du point d’entrée /authoring/destination-servers de l’API.

CONSEIL

Toute opération de mise à jour sur des destinations produites/publiques n’est visible qu’après avoir utilisé l’API de publication et envoyé la mise à jour pour révision Adobe.

Pour obtenir une description détaillée des fonctionnalités configurables avec ce point d’entrée, consultez les articles suivants :

IMPORTANT

Tous les noms et toutes les valeurs de paramètre pris en charge par Destination SDK sont sensibles à la casse. Pour éviter les erreurs de respect de la casse, utilisez les noms et valeurs des paramètres exactement comme indiqué dans la documentation.

Prise en main des opérations de l’API du serveur de destination

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 de serveur de destination

Vous pouvez mettre à jour une configuration de serveur de destination existante en effectuant une requête PUT au point d’entrée /authoring/destination-servers avec la payload mise à jour.

CONSEIL

Point d’entrée de l’API : platform.adobe.io/data/core/activation/authoring/destination-servers

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

Format d’API

PUT /authoring/destination-servers/{INSTANCE_ID}

Paramètre	Description
`{INSTANCE_ID}`	Identifiant de la configuration de serveur de destination que vous souhaitez mettre à jour. Pour obtenir une configuration de serveur de destination existante et son `{INSTANCE_ID}` correspondant, consultez la section Récupération d’une configuration de destination.

Les requêtes suivantes mettent à jour une configuration de serveur de destination existante, configurée par les paramètres fournis dans la payload.

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

Requête

curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destination-servers\{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 '
{
   "name":"Moviestar destination server",
   "destinationServerType":"URL_BASED",
   "urlBasedDestination":{
      "url":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"https://api.moviestar.com/data/{{customerData.region}}/items"
      }
   },
   "httpTemplate":{
      "httpMethod":"PUT",
      "requestBody":{
         "templatingStrategy":"PEBBLE_V1",
         "value":"{ \"attributes\": [ {% for ns in [\"external_id\", \"yourdestination_id\"] %} {% if input.profile.identityMap[ns] is not empty and first_namespace_encountered %} , {% endif %} {% set first_namespace_encountered = true %} {% for identity in input.profile.identityMap[ns]%} { \"{{ ns }}\": \"{{ identity.id }}\" {% if input.profile.segmentMembership.ups is not empty %} , \"AEPSegments\": { \"add\": [ {% for segment in input.profile.segmentMembership.ups %} {% if segment.value.status == \"realized\" or segment.value.status == \"existing\" %} {% if added_segment_found %} , {% endif %} {% set added_segment_found = true %} \"{{ destination.segmentAliases[segment.key] }}\" {% endif %} {% endfor %} ], \"remove\": [ {% for segment in input.profile.segmentMembership.ups %} {% if segment.value.status == \"exited\" %} {% if removed_segment_found %} , {% endif %} {% set removed_segment_found = true %} \"{{ destination.segmentAliases[segment.key] }}\" {% endif %} {% endfor %} ] } {% set removed_segment_found = false %} {% set added_segment_found = false %} {% endif %} {% if input.profile.attributes is not empty %} , {% endif %} {% for attribute in input.profile.attributes %} \"{{ attribute.key }}\": {% if attribute.value is empty %} null {% else %} \"{{ attribute.value.value }}\" {% endif %} {% if not loop.last%} , {% endif %} {% endfor %} } {% if not loop.last %} , {% endif %} {% endfor %} {% endfor %} ] }"
      },
      "contentType":"application/json"
   }
}

Paramètre	Type	Description
`name`	Chaîne	Obligatoire. Représente le nom convivial de votre serveur, visible uniquement par Adobe. Ce nom n’est pas visible pour les partenaires ou les clients. Par exemple, `Moviestar destination server`.
`destinationServerType`	Chaîne	Obligatoire. Définissez-le sur `URL_BASED` quand les destinations sont diffusées en temps réel (streaming).
`urlBasedDestination.url.templatingStrategy`	Chaîne	Obligatoire. Utilisez `PEBBLE_V1` si Adobe doit transformer l’URL dans le champ `value` ci-dessous. Utilisez cette option si vous disposez d’un point d’entrée tel que : `https://api.moviestar.com/data/{{customerData.region}}/items`. Utilisez `NONE` si aucune transformation n’est nécessaire du côté d’Adobe, par exemple si vous avez un point d’entrée tel que : `https://api.moviestar.com/data/items`.
`urlBasedDestination.url.value`	Chaîne	Obligatoire. Renseignez l’adresse du point d’entrée d’API auquel Experience Platform doit se connecter.
`httpTemplate.httpMethod`	Chaîne	Obligatoire. Méthode qu’Adobe utilise dans les appels vers votre serveur. Les options sont les suivantes : `GET`, `PUT`, `PUT`, `DELETE` ou `PATCH`.
`httpTemplate.requestBody.templatingStrategy`	Chaîne	Obligatoire. Utilisez `PEBBLE_V1`.
`httpTemplate.requestBody.value`	Chaîne	Obligatoire. Cette chaîne est la version avec caractères d’échappement qui transforme les données des clients Platform au format attendu par votre service. Pour plus d’informations sur l’écriture du modèle, lisez la section Utilisation des modèles. Pour plus d’informations sur l’échappement des caractères, reportez-vous à la section Norme RFC JSON, section 7. Pour obtenir un exemple de transformation simple, consultez la transformation des attributs de profil.
`httpTemplate.contentType`	Chaîne	Obligatoire. Type de contenu que votre serveur accepte. Cette valeur est probablement `application/json`.

Réponse