Guida per gli sviluppatori API per la gestione delle decisioni

Questa guida per sviluppatori descrive i passaggi per iniziare a utilizzare Offer Library API. La guida fornisce quindi esempi di chiamate API per eseguire operazioni chiave utilizzando il motore decisionale.

➡️ Ulteriori informazioni sui componenti di Gestione delle decisioni sono disponibili in questo video

Prerequisiti

Questa guida richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:

  • Experience Data Model (XDM) System: il quadro standardizzato mediante il quale Experience Platform organizza i dati sull’esperienza del cliente.
  • Gestione delle decisioni: illustra i concetti e i componenti utilizzati per Experience Decisioning in generale e per la gestione delle decisioni in particolare. Illustra le strategie utilizzate per scegliere l’opzione migliore da presentare durante l’esperienza di un cliente.
  • Profile Query Language (PQL): PQL è un linguaggio potente per scrivere espressioni sulle istanze XDM. PQL viene utilizzato per definire le regole di decisione.

Lettura delle chiamate API di esempio

Questa guida fornisce esempi di chiamate API per dimostrare come formattare le richieste. Questi includono percorsi, intestazioni richieste e payload di richieste formattati correttamente. Viene inoltre fornito il codice JSON di esempio restituito nelle risposte API. Per informazioni sulle convenzioni utilizzate nella documentazione per le chiamate API di esempio, consulta la sezione su come leggere esempi di chiamate API nel Experience Platform guida alla risoluzione dei problemi.

Raccogli i valori per le intestazioni richieste

Per effettuare chiamate a Adobe Experience Platform , devi prima completare le tutorial sull’autenticazione. Il completamento del tutorial sull’autenticazione fornisce i valori per ciascuna delle intestazioni richieste in tutte Experience Platform Chiamate API, come mostrato di seguito:

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {IMS_ORG}

Tutte le richieste che contengono un payload (POST, PUT, PATCH) richiedono un’intestazione aggiuntiva:

  • Content-Type: application/json

Gestire l’accesso a un contenitore

Un contenitore è un meccanismo di isolamento per tenere separate le diverse preoccupazioni. L’ID contenitore è il primo elemento percorso per tutte le API dell’archivio. Tutti gli oggetti decisioning si trovano all’interno di un contenitore.

Un amministratore può raggruppare entità principali e risorse simili e accedere alle autorizzazioni nei profili. Ciò riduce il carico di gestione ed è supportato da Adobe Admin Console. Per creare profili e assegnare utenti a Adobe Experience Platform nella tua organizzazione, devi essere amministratore di prodotto. È sufficiente creare profili di prodotto che soddisfino determinate autorizzazioni in un unico passaggio e quindi aggiungere semplicemente gli utenti a tali profili. I profili fungono da gruppi ai quali sono state concesse autorizzazioni e ogni utente reale o tecnico di quel gruppo eredita tali autorizzazioni.

Dati i privilegi di amministratore, puoi concedere o revocare le autorizzazioni agli utenti tramite Adobe Admin Console. For more information, see the Access control overview.

Elencare i contenitori accessibili agli utenti e alle integrazioni

Formato API

GET /{ENDPOINT_PATH}?product={PRODUCT_CONTEXT}&property={PROPERTY}==decisioning
Parametro Descrizione Esempio
{ENDPOINT_PATH} Percorso dell’endpoint per le API dell’archivio. https://platform.adobe.io/data/core/xcore/
{PRODUCT_CONTEXT} Filtra l’elenco dei contenitori in base alla loro associazione ai contesti di prodotto. acp
{PROPERTY} Filtra il tipo di contenitore restituito. _instance.containerType==decisioning

Richiesta

curl -X GET \
  'https://platform.adobe.io/data/core/xcore/?product=acp&property=_instance.containerType==decisioning' \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {IMS_ORG}' \
  -H 'x-sandbox-name: {SANDBOX_NAME}'

Risposta

In caso di esito positivo, la risposta restituisce le informazioni relative ai contenitori di gestione delle decisioni. Ciò include un instanceId , il cui valore corrisponde all'ID del contenitore.

{
    "_embedded": {
        "https://ns.adobe.com/experience/xcore/container": [
            {
                "instanceId": "{INSTANCE_ID}",
                "schemas": [
                    "https://ns.adobe.com/experience/xcore/container;version=0.5"
                ],
                "productContexts": [
                    "acp"
                ],
                "repo:etag": 2,
                "repo:createdDate": "2020-09-16T07:54:28.319959Z",
                "repo:lastModifiedDate": "2020-09-16T07:54:32.098139Z",
                "repo:createdBy": "{CREATED_BY}",
                "repo:lastModifiedBy": "{MODIFIED_BY}",
                "repo:createdByClientId": "{CREATED_CLIENT_ID}",
                "repo:lastModifiedByClientId": "{MODIFIED_CLIENT_ID}",
                "_instance": {
                    "containerType": "decisioning",
                    "repo:name": "{REPO_NAME}",
                    "dataCenter": "{DATA_CENTER}",
                    "parentName": "{PARENT_NAME}",
                    "parentId": "{PARENT_ID}"
                },
                "_links": {
                    "self": {
                        "href": "/containers/{INSTANCE_ID}"
                    }
                }
            }
        ]
    },
    "_links": {
        "self": {
            "href": "/?product=acp&property=_instance.containerType==decisioning",
            "@type": "https://ns.adobe.com/experience/xcore/hal/home"
        }
    }
}

Passaggi successivi

In questo documento sono state trattate le conoscenze preliminari necessarie per effettuare chiamate Offer Library API, inclusa l’acquisizione dell’ID contenitore. Ora puoi passare alle chiamate di esempio fornite in questa guida per sviluppatori e seguire le loro istruzioni.

Video introduttivo

Il video seguente ha lo scopo di aiutarti a comprendere i componenti di Gestione delle decisioni.

In questa pagina