Opérations de l’API du point d’entrée Publier les destinations

IMPORTANT

Point de terminaison de l’API: platform.adobe.io/data/core/activation/authoring/destinations/publish

Cette page répertorie et décrit toutes les opérations d’API que vous pouvez effectuer à l’aide du point de terminaison de l’API /authoring/destinations/publish.

Après avoir configuré et testé votre destination, vous pouvez l’envoyer à Adobe pour révision et publication.

Utilisez le point de terminaison de l’API des destinations de publication pour envoyer une requête de publication lorsque :

  • En tant que partenaire du SDK de destination, vous souhaitez rendre votre destination productisée disponible dans toutes les organisations Experience Platform pour que tous les clients Experience Platform puissent l’utiliser.
  • Vous souhaitez rendre votre destination personnalisée disponible dans votre propre organisation Experience Platform, dans tous les environnements de test.

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

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

Envoyer une configuration de destination pour publication

Vous pouvez envoyer une configuration de destination pour publication en envoyant une requête de POST au point de terminaison /authoring/destinations/publish .

Format d’API

POST /authoring/destinations/publish

Requête

La requête suivante envoie une destination pour la publication dans les organisations configurées par les paramètres fournis dans la payload. La payload ci-dessous inclut tous les paramètres acceptés par le point de terminaison /authoring/destinations/publish.

curl -X POST https://platform.adobe.io/data/core/activation/authoring/destinations/publish \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
   "destinationId":"1230e5e4-4ab8-4655-ae1e-a6296b30f2ec",
   "destinationAccess":"LIMITED",
   "allowedOrgs":[
      "xyz@AdobeOrg",
      "lmn@AdobeOrg"
   ]
}
Paramètre Type Description
destinationId Chaîne ID de destination de la configuration de destination que vous envoyez pour publication. Obtenez l’ID de destination d’une configuration de destination à l’aide de la référence de l’API de configuration de destination.
destinationAccess Chaîne ALL ou LIMITED. Indiquez si vous souhaitez que votre destination apparaisse dans le catalogue pour tous les clients Experience Platform ou uniquement pour certaines organisations.
Remarque : Si vous utilisez LIMITED, la destination sera publiée pour votre organisation Experience Platform uniquement. Si vous souhaitez publier la destination sur un sous-ensemble d’organisations Experience Platform à des fins de test client, contactez l’assistance Adobe.
allowedOrgs Chaîne Si vous utilisez "destinationAccess":"LIMITED", spécifiez les organisations Experience Platform pour lesquelles la destination sera disponible.

Réponse

Une réponse réussie renvoie un état HTTP 201 avec les détails de votre requête de publication de destination.

Liste des requêtes de publication de destination

Vous pouvez récupérer une liste de toutes les destinations envoyées pour publication pour votre organisation IMS en envoyant une requête GET au point de terminaison /authoring/destinations/publish .

Format d’API

GET /authoring/destinations/publish

Requête

La requête suivante récupère la liste des destinations soumises pour publication auxquelles vous avez accès, en fonction de l’organisation IMS et de la configuration des environnements de test.

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

Réponse

La réponse suivante renvoie un état HTTP 200 avec une liste des destinations soumises pour publication auxquelles vous avez accès, en fonction de l’identifiant de l’organisation IMS et du nom de l’environnement de test que vous avez utilisés. Un configId correspond à la requête de publication pour une destination.

{
   "destinationId":"1230e5e4-4ab8-4655-ae1e-a6296b30f2ec",
   "publishDetailsList":[
      {
         "configId":"string",
         "allowedOrgs":[
            "xyz@AdobeOrg",
            "lmn@AdobeOrg"
         ],
         "status":"TEST",
         "publishedDate":"1630617746"
      }
   ]
}
    
Paramètre Type Description
destinationId Chaîne ID de destination de la configuration de destination que vous avez envoyée pour publication.
publishDetailsList.configId Chaîne Identifiant unique de la requête de publication de destination pour votre destination envoyée.
publishDetailsList.allowedOrgs Chaîne Renvoie les organisations Experience Platform pour lesquelles la destination doit être disponible.
publishDetailsList.status Chaîne État de votre requête de publication de destination. Les valeurs possibles sont TEST, REVIEW, APPROVED, PUBLISHED, DENIED, REVOKED, DEPRECATED.
publishDetailsList.publishedDate Chaîne Date à laquelle la destination a été envoyée pour publication, dans l’heure considérée.

Mettre à jour une requête de publication de destination existante

Vous pouvez mettre à jour les organisations autorisées dans une requête de publication de destination existante en envoyant une requête de PUT au point de terminaison /authoring/destinations/publish et en fournissant l’identifiant de la destination pour laquelle vous souhaitez mettre à jour les organisations autorisées. Dans le corps de l’appel , fournissez les organisations autorisées mises à jour.

Format d’API

PUT /authoring/destinations/publish/{DESTINATION_ID}
Paramètre Description
{DESTINATION_ID} L’identifiant de la destination pour laquelle vous souhaitez mettre à jour la requête de publication.

Requête

La requête suivante met à jour une requête de publication de destination existante, configurée par les paramètres fournis dans le payload. Dans l’exemple d’appel ci-dessous, nous mettons à jour les organisations autorisées.

curl -X PUT https://platform.adobe.io/data/core/activation/authoring/destinations/publish/1230e5e4-4ab8-4655-ae1e-a6296b30f2ec \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
{
   "destinationId":"1230e5e4-4ab8-4655-ae1e-a6296b30f2ec",
   "destinationAccess":"LIMITED",
   "allowedOrgs":[
      "abc@AdobeOrg",
      "def@AdobeOrg"
   ]
}

Obtention de l’état d’une requête de publication de destination spécifique

Vous pouvez récupérer des informations détaillées sur une requête de publication de destination spécifique en effectuant une requête de GET sur le point de terminaison /authoring/destinations/publish et en fournissant l’identifiant de la destination pour laquelle vous souhaitez récupérer l’état de publication.

Format d’API

GET /authoring/destinations/publish/{DESTINATION_ID}
Paramètre Description
{DESTINATION_ID} L’identifiant de la destination pour laquelle vous souhaitez récupérer l’état de publication.

Requête

curl -X GET https://platform.adobe.io/data/core/activation/authoring/destinations/publish/1230e5e4-4ab8-4655-ae1e-a6296b30f2ec \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse

Une réponse réussie renvoie un état HTTP 200 avec des informations détaillées sur la requête de publication de destination spécifiée.

{
   "destinationId":"1230e5e4-4ab8-4655-ae1e-a6296b30f2ec",
   "publishDetailsList":[
      {
         "configId":"string",
         "allowedOrgs":[
            "xyz@AdobeOrg",
            "lmn@AdobeOrg"
         ],
         "status":"TEST",
         "publishedDate":"string"
      }
   ]
}

Gestion des erreurs d’API

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

Étapes suivantes

Après avoir lu ce document, vous savez désormais comment envoyer une requête de publication pour votre destination. L’équipe Adobe Experience Platform examinera votre demande de publication et vous recontactera pendant cinq jours ouvrables.

Sur cette page