Platform Domande frequenti e guida alla risoluzione dei problemi

Questo documento contiene le risposte alle domande frequenti su Adobe Experience Platform e una guida per la risoluzione dei problemi di alto livello per individuare eventuali errori comuni riscontrati in qualsiasi Experience Platform API. Per le guide alla risoluzione dei problemi sui singoli Platform servizi, consulta la directory per la risoluzione dei problemi del servizio di seguito.

Domande frequenti

Segue un elenco di risposte alle domande frequenti su Adobe Experience Platform.

Cosa sono Experience Platform le API?

Experience Platform offre più API RESTful che utilizzano richieste HTTP per accedere alle Platform risorse. Ciascuna di queste API di servizio espone più endpoint e consente di eseguire operazioni per elencare (GET), cercare (GET), modificare (PUT e/o PATCH) e eliminare (DELETE) risorse. Per ulteriori informazioni su endpoint e operazioni specifici disponibili per ogni servizio, consulta la documentazione di riferimento API Adobe I/O.

Come si formatta una richiesta API?

I formati delle richieste variano a seconda dell' Platform API utilizzata. Il modo migliore per imparare a strutturare le chiamate API è seguire gli esempi forniti nella documentazione relativa al Platform servizio in uso.

Lettura di chiamate API di esempio

La documentazione relativa Experience Platform agli esempi di chiamate API avviene in due modi diversi. Innanzitutto, la chiamata viene presentata nel suo formato ​API, una rappresentazione di modello che mostra solo l’operazione (GET, POST, PUT, PATCH, DELETE) e l’endpoint utilizzato (ad esempio, /global/classes). Alcuni modelli mostrano anche la posizione delle variabili per illustrare in che modo una chiamata deve essere formulata, ad esempio GET /{VARIABLE}/classes/{ANOTHER_VARIABLE}.

Le chiamate vengono quindi visualizzate come comandi cURL in una richiesta, che include le intestazioni necessarie e il "percorso di base" completo necessario per interagire con l'API. Il percorso di base deve essere preceduto da tutti gli endpoint. Ad esempio, l' /global/classes endpoint di cui sopra diventa https://platform.adobe.io/data/foundation/schemaregistry/global/classes. Vedrete il formato API/il pattern di richiesta in tutta la documentazione e dovrete utilizzare il percorso completo mostrato nella richiesta di esempio quando effettuerete chiamate alle API della piattaforma.

Esempio di richiesta API

Di seguito è riportata una richiesta API di esempio che illustra il formato che verrà trovato nella documentazione.

Formato API

Il formato API mostra l'operazione (GET) e l'endpoint in uso. Le variabili sono indicate da parentesi graffe (in questo caso, {CONTAINER_ID}).

GET /{CONTAINER_ID}/classes

Richiesta

In questa richiesta di esempio, alle variabili del formato API vengono assegnati valori effettivi nel percorso della richiesta. Vengono visualizzate anche tutte le intestazioni richieste, nonché valori di intestazione di esempio o variabili in cui includere informazioni riservate (come token di sicurezza e ID di accesso).

curl -X GET \
  https://platform.adobe.io/data/foundation/schemaregistry/global/classes \
  -H 'Accept: application/vnd.adobe.xed-id+json' \
  -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

La risposta illustra cosa ci si aspetta di ricevere in seguito a una chiamata all'API, in base alla richiesta inviata. Talvolta la risposta viene troncata per lo spazio, il che significa che potrebbero essere visualizzate ulteriori informazioni o informazioni aggiuntive rispetto a quelle visualizzate nell’esempio.

{
    "results": [
        {
            "title": "XDM ExperienceEvent",
            "$id": "https://ns.adobe.com/xdm/context/experienceevent",
            "meta:altId": "_xdm.context.experienceevent",
            "version": "1"
        },
        {
            "title": "XDM Individual Profile",
            "$id": "https://ns.adobe.com/xdm/context/profile",
            "meta:altId": "_xdm.context.profile",
            "version": "1"
        }
    ],
    "_links": {}
}

Per ulteriori informazioni su endpoint specifici nelle API della piattaforma, comprese le intestazioni richieste e i corpi di richiesta, consultate la documentazione di riferimentoAPI.

Qual è la mia organizzazione IMS?

Un'organizzazione IMS è una rappresentazione Adobe di un cliente. Tutte le soluzioni Adobe con licenza sono integrate con questa organizzazione cliente. Quando un'organizzazione IMS ha diritto a Experience Platform, può assegnare l'accesso agli sviluppatori. L'ID organizzazione IMS (x-gw-ims-org-id) rappresenta l'organizzazione per la quale deve essere eseguita una chiamata API ed è pertanto richiesto come intestazione in tutte le richieste API. Questo ID si trova tramite la consoleSviluppatore di Adobe: nella scheda Integrazioni , andate alla sezione Panoramica di una particolare integrazione per trovare l’ID in Credenziali client. Per una descrizione dettagliata di come autenticarsi, Platformconsulta l’esercitazione sull’autenticazione.

Dove posso trovare la mia chiave API?

Una chiave API è obbligatoria come intestazione in tutte le richieste API. È possibile accedervi tramite la Developer Console. Nella console, nella scheda Integrazioni , passare alla sezione Panoramica per un'integrazione specifica e la chiave si trova in Credenziali client. Per una descrizione dettagliata di come autenticarsi, Platformconsulta l’esercitazione sull’autenticazione.

Come posso ottenere un token di accesso?

I token di accesso sono richiesti nell'intestazione Autorizzazione di tutte le chiamate API. Possono essere generati utilizzando un curl comando, a condizione che sia possibile accedere a un'integrazione per un'organizzazione IMS. I token di accesso sono validi solo 24 ore, dopo di che è necessario generare un nuovo token per continuare a utilizzare l'API. Per informazioni dettagliate sulla generazione dei token di accesso, consultate l'esercitazione sull'autenticazione.

Come si utilizzano i parametri di query?

Alcuni endpoint Platform API accettano parametri di query per individuare informazioni specifiche e filtrare i risultati restituiti nella risposta. I parametri di query vengono aggiunti ai percorsi di richiesta con un simbolo di punto interrogativo (?), seguiti da uno o più parametri di query che utilizzano il formato paramName=paramValue. Quando si combinano più parametri in una singola chiamata, è necessario utilizzare una e commerciale (&) per separare i singoli parametri. L'esempio seguente illustra come una richiesta che utilizza più parametri di query viene rappresentata nella documentazione.

Alcuni esempi di parametri di query comunemente utilizzati:

GET /tenant/schemas?orderby=title
GET /datasets?limit=36&start=10
GET /batches?createdAfter=1559775880000&orderBy=desc:created

Per informazioni dettagliate sui parametri di query disponibili per un servizio o un endpoint specifico, consulta la documentazione specifica del servizio.

Come posso indicare un campo JSON da aggiornare in una richiesta di PATCH?

Molte operazioni PATCH nelle Platform API utilizzano le stringhe JSON Pointer per indicare le proprietà JSON da aggiornare. Questi sono in genere inclusi nei payload di richiesta utilizzando il formato Patch JSON. Per informazioni dettagliate sulla sintassi richiesta per queste tecnologie, consultate la guida API di base.

Posso usare Postman per effettuare chiamate alle Platform API?

Postman è uno strumento utile per visualizzare le chiamate alle API RESTful. Questo post Medium descrive come impostare Postman per eseguire automaticamente l'autenticazione e utilizzarlo per utilizzare Experience Platform le API.

Quali sono i requisiti di sistema per Platform?

A seconda se utilizzate l'interfaccia utente o l'API, si applicano i seguenti requisiti di sistema:

Per le operazioni basate sull’interfaccia utente:

  • Un browser Web standard e moderno. Sebbene Chrome sia consigliata la versione più recente di, sono supportate anche le versioni principali correnti e precedenti di Firefox, Internet Explorere Safari.
    • Ogni volta che viene rilasciata una nuova versione principale, Platform inizia a supportare la versione più recente, mentre viene eliminato il supporto per la terza versione più recente.
  • Tutti i browser devono avere cookie e JavaScript abilitati.

Per le interazioni API e sviluppatore:

  • Un ambiente di sviluppo per le integrazioni REST, streaming e Webhook.

Errori e risoluzione dei problemi

Di seguito è riportato un elenco di errori che potrebbero verificarsi durante l'utilizzo di un qualsiasi Experience Platform servizio. Per le guide alla risoluzione dei problemi sui singoli Platform servizi, consulta la directory per la risoluzione dei problemi del servizio di seguito.

Codici di stato API

I seguenti codici di stato possono essere rilevati su qualsiasi Experience Platform API. Ognuno ha una varietà di cause, quindi le spiegazioni fornite in questa sezione sono di natura generale. Per ulteriori informazioni sugli errori specifici dei singoli Platform servizi, consulta la directory per la risoluzione dei problemi dei servizi di seguito.

Codice di stato Descrizione Possibili cause
400 Richiesta non valida La richiesta è stata costruita in modo non corretto, le informazioni chiave mancanti e/o conteneva una sintassi non corretta.
401 Autenticazione non riuscita La richiesta non ha superato un controllo di autenticazione. Token di accesso mancante o non valido. Per ulteriori informazioni, consulta la sezione Errori token OAuth riportata di seguito.
403 Vietato La risorsa è stata trovata, ma non si dispone delle credenziali giuste per visualizzarla.
404 Non trovato Impossibile trovare la risorsa richiesta sul server. La risorsa potrebbe essere stata eliminata oppure il percorso richiesto non è stato inserito correttamente.
500 Errore interno del server Si tratta di un errore lato server. Se state effettuando molte chiamate simultanee, potreste raggiungere il limite API e dover filtrare i risultati. Per ulteriori informazioni, consultate la guida per gli sviluppatori di Catalog Service API nella guida secondaria sul filtro dei dati . Attendete un momento prima di riprovare a eseguire la richiesta e, se il problema persiste, contattate l'amministratore.

Errori di intestazione richiesta

Tutte le chiamate API in Platform richiedono intestazioni di richiesta specifiche. Per vedere quali intestazioni sono necessarie per i singoli servizi, consulta la documentazione di riferimentoAPI. Per trovare i valori per le intestazioni di autenticazione richieste, vedete l'esercitazione Autenticazione. Se una di queste intestazioni risulta mancante o non valida durante una chiamata API, si possono verificare i seguenti errori.

Token OAuth mancante

{
    "error_code": "403010",
    "message": "Oauth token is missing."
}

Questo messaggio di errore viene visualizzato quando manca un' Authorization intestazione da una richiesta API. Prima di riprovare, verificate che l’intestazione Autorizzazione sia inclusa con un token di accesso valido.

Token OAuth non valido

{
    "error_code": "401013",
    "message": "Oauth token is not valid"
}

Questo messaggio di errore viene visualizzato quando il token di accesso fornito nell' Authorization intestazione non è valido. Verificate che il token sia stato immesso correttamente o generate un nuovo token nella console I/O Adobe.

Chiave API obbligatoria

{
    "error_code": "403000",
    "message": "Api Key is required"
}

Questo messaggio di errore viene visualizzato quando manca un'intestazione di chiave API (x-api-key) da una richiesta API. Prima di riprovare, accertatevi che l'intestazione sia inclusa con una chiave API valida.

Chiave API non valida

{
    "error_code": "403003",
    "message": "Api Key is invalid"
}

Questo messaggio di errore viene visualizzato quando il valore dell'intestazione della chiave API (x-api-key) specificata non è valido. Prima di riprovare, verificate di aver immesso correttamente la chiave. Se non conosci la tua chiave API, puoi trovarlo nella console I/OAdobe: nella scheda Integrazioni , andate alla sezione Panoramica di un'integrazione specifica per trovare la chiave API in Credenziali client.

Intestazione mancante

{
    "error_code": "400003",
    "message": "Missing header"
}

Questo messaggio di errore viene visualizzato quando un'intestazione organizzazione IMS (x-gw-ims-org-id) non è presente in una richiesta API. Prima di riprovare, accertatevi che l’intestazione sia inclusa con l’ID dell’organizzazione IMS.

Profilo non valido

{
    "error_code": "403025",
    "message": "Profile is not valid"
}

Questo messaggio di errore viene visualizzato quando l'integrazione I/O utente o Adobe (identificata dal token di accesso nell' Authorization intestazione) non ha diritto di effettuare chiamate alle Experience Platform API per l'organizzazione IMS fornita nell' x-gw-ims-org-id intestazione. Prima di riprovare, verificate di aver fornito l’ID corretto per l’organizzazione IMS nell’intestazione. Se non conosci il tuo ID organizzazione, puoi trovarlo nella console I/OAdobe: nella scheda Integrazioni , andate alla sezione Panoramica di un'integrazione specifica per trovare l'ID in Credenziali client.

Tipo di contenuto valido non specificato

{
    "type": "/placeholder/type/uri",
    "status": 400,
    "title": "BadRequestError",
    "detail": "A valid content-type must be specified"
}

Questo messaggio di errore viene visualizzato quando una richiesta di POST, PUT o PATCH ha un'intestazione non valida o mancante Content-Type . Accertatevi che l’intestazione sia inclusa nella richiesta e che il relativo valore sia application/json.

Directory di risoluzione dei problemi del servizio

Di seguito è riportato un elenco di guide per la risoluzione dei problemi e di documentazione di riferimento API per Experience Platform le API. Ogni guida alla risoluzione dei problemi fornisce risposte alle domande frequenti e soluzioni ai problemi specifici dei singoli Platform servizi. I documenti di riferimento API forniscono una guida completa a tutti gli endpoint disponibili per ciascun servizio, e mostrano i corpi delle richieste di esempio, le risposte e i codici di errore che possono essere ricevuti.

Servizio Riferimento API Risoluzione dei problemi
Controllo di accesso API di controllo degli accessi Guida alla risoluzione dei problemi di controllo degli accessi
Ingestione dati Adobe Experience Platform Data Ingestion API Guida

alla risoluzione dei problemi di acquisizione batchGuida alla risoluzione dei problemi di assimilazione dello streaming
Adobe Experience Platform Data Science Workspace Sensei Machine Learning API Data Science Workspace guida alla risoluzione dei problemi
Adobe Experience Platform Data Governance Policy Service API
Servizio Adobe Experience Platform Identity Identity Service API Identity Service guida alla risoluzione dei problemi
Adobe Experience Platform Query Service Query Service API Query Service guida alla risoluzione dei problemi
Segmentazione Adobe Experience Platform Segmentation API
Catalog Service Catalog Service API
Experience Data Model (XDM) Schema Registry API XDM System Domande frequenti e guida alla risoluzione dei problemi
Flow Service (Sources ed Destinations) Flow Service API
Real-time Customer Profile Real-time Customer Profile API Profile guida alla risoluzione dei problemi
Sandbox API sandbox Guida alla risoluzione dei problemi sandbox

In questa pagina