Guida per gli sviluppatori API per la gestione delle decisioni

Questa guida per gli sviluppatori descrive i passaggi necessari per iniziare a utilizzare Offer Library API. La guida fornisce quindi un esempio di chiamate API per eseguire operazioni chiave utilizzando il modulo di gestione delle decisioni.

➡️ Questo video offre ulteriori informazioni sui componenti di Gestione delle decisioni .

Prerequisiti

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

Lettura di 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 richiesta formattati correttamente. Viene inoltre fornito un esempio di codice JSON restituito nelle risposte API. Per informazioni sulle convenzioni utilizzate nella documentazione per le chiamate API di esempio, consulta la sezione sulle come leggere le chiamate API di esempio nel Experience Platform guida alla risoluzione dei problemi.

Raccogli i valori delle intestazioni richieste

Per effettuare chiamate a Adobe Experience Platform API, devi prima completare l’ esercitazione sull’autenticazione. Il completamento dell’esercitazione sull’autenticazione fornisce i valori per ciascuna delle intestazioni richieste in tutte le 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 del percorso per tutte le API dell’archivio. Tutti gli oggetti decisionali risiedono all'interno di un contenitore.

Un amministratore può raggruppare entità, risorse e autorizzazioni di accesso simili in profili. Ciò riduce l’onere di gestione ed è supportato da Adobe Admin Console. Devi essere un amministratore di prodotto per Adobe Experience Platform nella tua organizzazione per creare profili e assegnare loro gli utenti. È sufficiente creare profili di prodotto che corrispondano a determinate autorizzazioni in un unico passaggio e quindi aggiungere semplicemente gli utenti a tali profili. I profili fungono da gruppi a cui sono state concesse autorizzazioni e ogni utente effettivo o tecnico del gruppo eredita tali autorizzazioni.

In base ai privilegi di amministratore, è possibile concedere o revocare le autorizzazioni agli utenti tramite Adobe Admin Console. Per ulteriori informazioni, consulta la sezione Panoramica sul controllo degli accessi.

Elencare contenitori accessibili a utenti e integrazioni

Formato API

GET /{ENDPOINT_PATH}?product={PRODUCT_CONTEXT}&property={PROPERTY}==decisioning
Parametro Descrizione Esempio
{ENDPOINT_PATH} Percorso 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

Una risposta corretta restituisce informazioni relative ai contenitori di gestione delle decisioni. Questo include instanceId , il cui valore è l'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

Il presente documento tratta le conoscenze 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 gli sviluppatori e seguire le relative istruzioni.

NOTA

Il canale di messaggistica in-app in Adobe Journey Optimizer utilizza oggetti di offer decisioning. Se l’organizzazione utilizza il canale di messaggistica in-app, le richieste di elenco API per gli oggetti includeranno gli oggetti creati dal servizio di messaggistica in-app e possono essere ignorate per offer decisioning casi d’uso. Gli oggetti creati per i messaggi in-app avranno createdBy = “Mobile_Sheliak”.

Video introduttivo

Il seguente video è pensato per aiutarti a comprendere i componenti di Gestione delle decisioni.

In questa pagina