Operazioni API per il test di destinazione

IMPORTANTE

Endpoint API: https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/

Questa pagina elenca e descrive tutte le operazioni API che puoi eseguire utilizzando l’ endpoint API /authoring/testing/destinationInstance/, per verificare se la destinazione è configurata correttamente e per verificare l’integrità dei flussi di dati nella destinazione configurata. Per una descrizione delle funzionalità supportate da questo endpoint, leggere Verifica la configurazione di destinazione.

Esegui richieste all’endpoint di test con o senza aggiungere profili alla chiamata . Se non invii profili alla richiesta, Adobe li genererà internamente per te e li aggiungerà alla richiesta.

Puoi utilizzare l’ API di generazione del profilo di esempio per creare profili da utilizzare nelle richieste per l’API di test di destinazione.

Come ottenere l'ID dell'istanza di destinazione

IMPORTANTE

Guida introduttiva al test della destinazione delle operazioni API

Prima di continuare, controlla la guida introduttiva per informazioni importanti che devi conoscere per effettuare correttamente le chiamate all'API, tra cui come ottenere l'autorizzazione di authoring di destinazione richiesta e le intestazioni richieste.

Verifica la configurazione di destinazione senza aggiungere profili alla chiamata .

Puoi verificare la configurazione di destinazione effettuando una richiesta di POST all’ endpoint authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID} e specificando l’ID dell’istanza di destinazione della destinazione che stai testando.

Formato API

POST authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}
Parametro query Descrizione
{DESTINATION_INSTANCE_ID} L'ID dell'istanza di destinazione della destinazione che stai testando.

Richiesta

La richiesta seguente chiama l’endpoint API REST della destinazione. La richiesta è configurata dal parametro di query {DESTINATION_INSTANCE_ID} .

curl --location --request GET '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: {IMS_ORG}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \

Risposta

Una risposta corretta restituisce lo stato HTTP 200 insieme alla risposta API dall’endpoint REST API della destinazione.

{
   "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"
            }
         }
      }
   ]
}
Proprietà Descrizione
aggregationKey Include informazioni sul criterio di aggregazione configurato per la destinazione. Per ulteriori informazioni, consulta la sezione Criteri di aggregazione nel documento di configurazione della destinazione.
traceId Identificatore univoco per l'operazione. Quando si verificano degli errori, puoi condividere questo ID con il team di Adobe per scopi di risoluzione dei problemi.
results.httpCalls.request Include la richiesta inviata da Adobe alla destinazione.
results.httpCalls.response Include la risposta ricevuta dall’Adobe dalla destinazione.
inputProfiles Include i profili esportati nella chiamata alla destinazione. I profili corrispondono allo schema di origine.

Verifica la configurazione di destinazione con i profili aggiunti alla chiamata .

Puoi verificare la configurazione di destinazione effettuando una richiesta di POST all’ endpoint authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID} e specificando l’ID dell’istanza di destinazione della destinazione che stai testando.

Formato API

POST authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}
Parametro query Descrizione
{DESTINATION_INSTANCE_ID} L'ID dell'istanza di destinazione della destinazione che stai testando.

Richiesta

La richiesta seguente chiama l’endpoint API REST della destinazione. La richiesta è configurata dai parametri forniti nel payload e dal parametro di query {DESTINATION_INSTANCE_ID} .

curl --location --request GET '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: {IMS_ORG}' \
--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"
            }
         }
      }
   ]
}'

Risposta

Una risposta corretta restituisce lo stato HTTP 200 insieme alla risposta API dall’endpoint REST API della destinazione.

{
   "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"
            }
         }
      }
   ]
}

Gestione degli errori API

Gli endpoint API SDK di destinazione seguono i principi generali dei messaggi di errore API di Experience Platform. Consulta Codici di stato API e richiedi errori di intestazione nella guida alla risoluzione dei problemi di Platform.

Passaggi successivi

Dopo aver letto questo documento, ora sai come verificare la destinazione. Ora puoi utilizzare l'Adobe processo di documentazione self-service per creare una pagina di documentazione per la tua destinazione.

In questa pagina