Opérations de l’API pour les tests de destination

IMPORTANT

Point d’entrée de l’API : https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/

Cette page répertorie et décrit toutes les opérations d’API que vous pouvez effectuer à l’aide du /authoring/testing/destinationInstance/ Point de terminaison de l’API, pour tester si votre destination est configurée correctement et pour vérifier l’intégrité des flux de données vers votre destination configurée. Pour une description de la fonctionnalité prise en charge par ce point de terminaison, reportez-vous à la section Test de votre configuration de destination.

Vous envoyez des requêtes au point de terminaison de test avec ou sans ajouter de profils à l’appel . Si vous n’envoyez aucun profil à la demande, Adobe les génère en interne et les ajoute à la demande.

Vous pouvez utiliser la variable Exemple d’API de génération de profil pour créer des profils à utiliser dans les requêtes de l’API de test de destination.

Comment obtenir l’ID d’instance de destination

IMPORTANT

Prise en main des opérations de l’API de test 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 requis.

Tester la configuration de votre destination sans ajouter de profils à l’appel

Vous pouvez tester votre configuration de destination en adressant une requête de POST au authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID} point de terminaison et en indiquant l’identifiant de l’instance de destination de la destination que vous testez.

Format d’API

POST authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}
Paramètre de requête Description
{DESTINATION_INSTANCE_ID} L’ID d’instance de destination de la destination que vous testez.

Requête

La requête suivante appelle le point de terminaison de l’API REST de votre destination. La requête est configurée par la fonction {DESTINATION_INSTANCE_ID} paramètre de requête.

curl --location --request POST 'https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/49966037-32cd-4457-a105-2cbf9c01826a' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: {API_KEY}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \

Réponse

Une réponse réussie renvoie un état HTTP 200 avec la réponse de l’API provenant du point de terminaison de l’API REST de votre destination.

{
   "results":[
      {
         "aggregationKey":{
            "destinationInstanceId":"string",
            "segmentId":"string",
            "segmentStatus":"realized",
            "identityNamespaces":[
               [
                  "email",
                  "phone"
               ]
            ]
         },
         "httpCalls":[
            {
               "traceId":"a06fec2d-a886-4219-8975-4e4b7ed26539",
               "request":{
                  "body":"{ \"attributes\": [  { \"external_id\": \"external_id-h29Fq\"  , \"AdobeExperiencePlatformSegments\": { \"add\": [  \"Nirvana fans\" ,  \"RHCP fans\"   ], \"remove\": [  ] }  ,  \"key\":  \"string\"    }  ] }",
                  "headers":[
                     {
                        "Content-Type":"application/json"
                     }
                  ],
                  "method":"POST",
                  "uri":"https://api.moviestar.com/users/track"
               },
               "response":{
                  "body":"{\"status\": \"success\"}",
                  "code":"200",
                  "headers":[
                     {
                        "Connection":"keep-alive"
                     },
                     {
                        "Content-Type":"application/json"
                     },
                     {
                        "Server":"nginx"
                     },
                     {
                        "Vary":"Origin,Accept-Encoding"
                     },
                     {
                        "transfer-encoding":"chunked"
                     }
                  ]
               }
            }
         ]
      }
   ],
   "inputProfiles":[
      {
         "segmentMembership":{
            "ups":{
               "03fb9938-8537-4b4c-87f9-9c4d413a0ee5":{
                  "lastQualificationTime":"2021-06-17T12:25:12.872039Z",
                  "status":"realized"
               },
               "27e05542-d6a3-46c7-9c8e-d59d50229530":{
                  "lastQualificationTime":"2021-06-17T12:25:12.872042Z",
                  "status":"realized"
               }
            }
         },
         "personalEmail":{
            "address":"john.smith@abc.com"
         },
         "identityMap":{
            "ECID":[
               {
                  "id":"ECID-vlnt6"
               }
            ]
         },
         "person":{
            "name":{
               "firstName":"string"
            }
         }
      }
   ]
}
Propriété Description
aggregationKey Inclut des informations sur la stratégie d’agrégation configurée pour la destination. Pour plus d’informations, reportez-vous à la section Stratégie d’agrégation dans le document de configuration de destination.
traceId Identifiant unique de l’opération. En cas d’erreur, vous pouvez partager cet identifiant avec l’équipe Adobe à des fins de dépannage.
results.httpCalls.request Inclut la demande qui a été envoyée par Adobe à votre destination.
results.httpCalls.response Inclut la réponse reçue par l’Adobe de votre destination.
inputProfiles Inclut les profils qui ont été exportés lors de l’appel vers votre destination. Les profils correspondent à votre schéma source.

Tester la configuration de votre destination avec les profils ajoutés à l’appel

Vous pouvez tester votre configuration de destination en adressant une requête de POST au authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID} point de terminaison et en indiquant l’identifiant de l’instance de destination de la destination que vous testez.

Format d’API

POST authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}
Paramètre de requête Description
{DESTINATION_INSTANCE_ID} L’ID d’instance de destination de la destination que vous testez.

Requête

La requête suivante appelle le point de terminaison de l’API REST de votre destination. La requête est configurée par les paramètres fournis dans la payload et la variable {DESTINATION_INSTANCE_ID} paramètre de requête.

curl --location --request POST 'https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/49966037-32cd-4457-a105-2cbf9c01826a' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: {API_KEY}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
--data-raw '{
   "profiles":[
      {
         "segmentMembership":{
            "ups":{
               "374a9a6c-c719-4cdb-a660-155a2838e6d6":{
                  "lastQualificationTime":"2021-05-13T12:16:27.248585Z",
                  "status":"realized"
               },
               "896f8776-9498-47b4-b994-51cb3f61c2c5":{
                  "lastQualificationTime":"2021-05-13T12:16:27.248605Z",
                  "status":"realized"
               }
            }
         },
         "identityMap":{
            "ECID":[
               {
                  "id":"ECID-Z3i2t"
               }
            ],
            "external_id":[
               {
                  "id":"external_id-h29Fq"
               }
            ]
         },
         "attributes":{
            "firstName":{
               "value":"John"
            }
         }
      }
   ]
}'

Réponse

Une réponse réussie renvoie un état HTTP 200 avec la réponse de l’API provenant du point de terminaison de l’API REST de votre destination.

{
   "results":[
      {
         "aggregationKey":{
            "destinationInstanceId":"string",
            "segmentId":"string",
            "segmentStatus":"realized",
            "identityNamespaces":[
               [
                  "email",
                  "phone"
               ]
            ]
         },
         "httpCalls":[
            {
               "traceId":"a06fec2d-a886-4219-8975-4e4b7ed26539",
               "request":{
                  "body":"{ \"attributes\": [  { \"external_id\": \"external_id-h29Fq\"  , \"AdobeExperiencePlatformSegments\": { \"add\": [  \"Nirvana fans\" ,  \"RHCP fans\"   ], \"remove\": [  ] }  ,  \"key\":  \"string\"    }  ] }",
                  "headers":[
                     {
                        "Content-Type":"application/json"
                     }
                  ],
                  "method":"POST",
                  "uri":"https://api.moviestar.com/users/track"
               },
               "response":{
                  "body":"{\"status\": \"success\"}",
                  "code":"200",
                  "headers":[
                     {
                        "Connection":"keep-alive"
                     },
                     {
                        "Content-Type":"application/json"
                     },
                     {
                        "Server":"nginx"
                     },
                     {
                        "Vary":"Origin,Accept-Encoding"
                     },
                     {
                        "transfer-encoding":"chunked"
                     }
                  ]
               }
            }
         ]
      }
   ],
   "inputProfiles":[
      {
         "segmentMembership":{
            "ups":{
               "374a9a6c-c719-4cdb-a660-155a2838e6d6":{
                  "lastQualificationTime":"2021-05-13T12:16:27.248585Z",
                  "status":"realized"
               },
               "896f8776-9498-47b4-b994-51cb3f61c2c5":{
                  "lastQualificationTime":"2021-05-13T12:16:27.248605Z",
                  "status":"realized"
               }
            }
         },
         "identityMap":{
            "ECID":[
               {
                  "id":"ECID-Z3i2t"
               }
            ],
            "external_id":[
               {
                  "id":"external_id-h29Fq"
               }
            ]
         },
         "attributes":{
            "firstName":{
               "value":"John"
            }
         }
      }
   ]
}

Gestion des erreurs d’API

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 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 maintenant comment tester votre destination. Vous pouvez désormais utiliser l’Adobe processus de documentation en libre-service pour créer une page de documentation pour votre destination.

Sur cette page