Platform Domande frequenti e guida alla risoluzione dei problemi

Questo documento fornisce le risposte alle domande frequenti su Adobe Experience Platform e una guida per la risoluzione dei problemi di alto livello per gli errori comuni che possono verificarsi in qualsiasi API Experience Platform. Per le guide alla risoluzione dei problemi sui singoli servizi Platform, consulta la directory per la risoluzione dei problemi dei servizi di seguito.

Domande frequenti

Di seguito è riportato un elenco di risposte alle domande frequenti su Adobe Experience Platform.

Cosa sono le API Experience Platform?

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

Come si formatta una richiesta API?

I formati di richiesta variano a seconda dell’ Platform API utilizzata. Il modo migliore per imparare a strutturare le chiamate API è seguire gli esempi forniti nella documentazione del particolare servizio Platform che utilizzi.

Per ulteriori informazioni sulla formattazione delle richieste API, visita la sezione Guida introduttiva all’API Platform lettura di chiamate API di esempio .

Qual è la mia organizzazione IMS?

Un’organizzazione IMS è un Adobe di rappresentazione di un cliente. Tutte le soluzioni di Adobe con licenza sono integrate con questa organizzazione clienti. 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 Adobe Developer Console: nella scheda Integrazioni , passa alla sezione Panoramica per qualsiasi integrazione particolare e trova l'ID in Credenziali client. Per informazioni dettagliate su come eseguire l'autenticazione in Platform, consulta l' esercitazione sull'autenticazione.

Dove posso trovare la mia chiave API?

Una chiave API è necessaria come intestazione in tutte le richieste API. È disponibile tramite la Console per sviluppatori di Adobe. Nella console, nella scheda Integrazioni , passa alla sezione Panoramica per una specifica integrazione e troverai la chiave in Credenziali client. Per informazioni dettagliate su come eseguire l'autenticazione in Platform, consulta l' esercitazione sull'autenticazione.

Come posso ottenere un token di accesso?

I token di accesso sono necessari nell’intestazione Autorizzazione di tutte le chiamate API. Possono essere generati utilizzando un comando curl, purché sia possibile accedere a un’integrazione per un’organizzazione IMS. I token di accesso sono validi solo per 24 ore, dopodiché è necessario generare un nuovo token per continuare a utilizzare l’API. Per informazioni dettagliate sulla generazione dei token di accesso, consulta 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 (?) seguito da uno o più parametri di query che utilizzano il formato paramName=paramValue. Quando combini più parametri in una singola chiamata, devi 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 si indica un campo JSON da aggiornare in una richiesta PATCH?

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

Posso utilizzare Postman per effettuare chiamate alle API Platform?

🔗 Postmanis uno strumento utile per visualizzare le chiamate alle API RESTful. La guida introduttiva all’API Platform contiene un video e istruzioni per l’importazione di raccolte Postman. Inoltre, viene fornito un elenco di raccolte Postman per ogni servizio.

Quali sono i requisiti di sistema per Platform?

A seconda dell’interfaccia utente o dell’API, si applicano i seguenti requisiti di sistema:

Per le operazioni basate sull’interfaccia utente:

• Un browser web moderno e standard. È consigliata anche l’ultima versione di Chrome , ma sono supportate anche le versioni principali correnti e precedenti di Firefox, Internet Explorer e 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 i cookie e JavaScript abilitati.

Per le interazioni con API e sviluppatori:

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

Errori e risoluzione dei problemi

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

Codici di stato API

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

Errori di intestazione della 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 riferimento API. Per trovare i valori per le intestazioni di autenticazione richieste, consulta l’ esercitazione sull’autenticazione. Se una di queste intestazioni è mancante o non è valida durante una chiamata API, potrebbero verificarsi i seguenti errori.

Token OAuth mancante

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

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

Il 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'intestazione Authorization non è valido. Assicurati che il token sia stato immesso correttamente oppure genera un nuovo token nella console Adobe I/O.

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. Assicurati che l’intestazione sia inclusa con una chiave API valida prima di riprovare.

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 fornita (x-api-key) non è valido. Assicurati di aver immesso correttamente la chiave prima di riprovare. Se non conosci la tua chiave API, puoi trovarlo nella Console Adobe I/O: nella scheda Integrazioni , passa alla sezione Panoramica per una specifica integrazione per trovare la chiave API in Credenziali client.

Intestazione mancante

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

Questo messaggio di errore viene visualizzato quando manca un'intestazione organizzazione IMS (x-gw-ims-org-id) da una richiesta API. Assicurati che l’intestazione sia inclusa con l’ID della tua organizzazione IMS prima di riprovare.

Profilo non valido

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

Questo messaggio di errore viene visualizzato quando l’utente o l’integrazione di Adobe I/O (identificata dal token di accesso nell’ intestazione Authorization ) non è autorizzata a effettuare chiamate alle API Experience Platform per l’organizzazione IMS fornita nell’intestazione x-gw-ims-org-id . Assicurati di aver fornito l’ID corretto per la tua organizzazione IMS nell’intestazione prima di riprovare. Se non conosci il tuo ID organizzazione, puoi trovarlo nella Console di Adobe I/O: nella scheda Integrazioni , passa alla sezione Panoramica per una specifica integrazione e trova 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 presenta un'intestazione Content-Type non valida o mancante. Verifica che l’intestazione sia inclusa nella richiesta e che il relativo valore sia application/json.

Area utente mancante

{
    "error_code": "403027",
    "message": "User region is missing"
}

Questo messaggio di errore viene visualizzato quando l’account (rappresentato dalle credenziali di autenticazione fornite) non è associato, ad Experience Platform, a un profilo di prodotto. Segui i passaggi descritti in generazione di credenziali di accesso nell’esercitazione sull’autenticazione dell’API Platform per aggiungere Platform al tuo account e aggiornare di conseguenza le tue credenziali di autenticazione.

Directory dei servizi per la risoluzione dei problemi

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