Platform Domande frequenti e guida alla risoluzione dei problemi

Questo documento fornisce le risposte alle domande più frequenti su Adobe Experience Platform, nonché una guida alla risoluzione dei problemi di alto livello per gli errori comuni che possono verificarsi in qualsiasi Experience Platform API. Per guide sulla risoluzione dei problemi individuali Platform servizi, vedi directory di risoluzione dei problemi del servizio sotto.

Domande frequenti

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

Cosa sono Experience Platform API?

Experience Platform offre più API RESTful che utilizzano richieste HTTP per accedere 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 sezione Documentazione di riferimento API Adobe I/O.

Come si formatta una richiesta API?

I formati di richiesta variano a seconda del Platform API utilizzata. Il modo migliore per strutturare le chiamate API è seguire gli esempi forniti nella documentazione per Platform servizio in uso.

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

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. ID organizzazione IMS (x-gw-ims-org-id) rappresenta l’organizzazione per la quale deve essere eseguita una chiamata API ed è pertanto obbligatoria come intestazione in tutte le richieste API. Questo ID può essere trovato attraverso Console per sviluppatori di Adobe: in Integrazioni , passa alla Panoramica sezione per qualsiasi integrazione particolare per trovare l’ID in Credenziali client. Per informazioni dettagliate su come eseguire l'autenticazione in Platform, vedi esercitazione sull'autenticazione.

Dove posso trovare la mia chiave API?

Una chiave API è necessaria come intestazione in tutte le richieste API. Può essere trovato attraverso Console per sviluppatori di Adobe. Nella console, nella Integrazioni , passa alla Panoramica per un’integrazione specifica e troverai la chiave in Credenziali client. Per informazioni dettagliate su come eseguire l'autenticazione in Platform, vedi 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 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 la sezione esercitazione sull'autenticazione.

Come si utilizzano i parametri di query?

Alcuni Platform Gli endpoint 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 punto interrogativo (?), seguita 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 di PATCH in Platform Utilizzo delle API Puntatore JSON stringhe per indicare le proprietà JSON da aggiornare. In genere sono inclusi nei payload di richiesta utilizzando Patch JSON formato. Consulta la sezione Guida di base sulle API per informazioni dettagliate sulla sintassi richiesta per queste tecnologie.

Posso usare Postman per effettuare chiamate a Platform API?

Postman è uno strumento utile per visualizzare le chiamate alle API RESTful. La Guida introduttiva all’API di 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. Mentre l'ultima versione di Chrome è consigliato, versioni principali attuali e precedenti di Firefox, Internet ExplorerSono supportati anche Safari e .
  • 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 quando si utilizzano Experience Platform servizio. Per guide sulla risoluzione dei problemi individuali Platform servizi, vedi directory di risoluzione dei problemi del servizio sotto.

Codici di stato API

È possibile rilevare i seguenti codici di stato su qualsiasi Experience Platform API. Ognuno ha una varietà di cause, quindi le spiegazioni fornite in questa sezione sono di natura generale. Per maggiori dettagli sugli errori specifici in singoli Platform i servizi directory di risoluzione dei problemi del servizio sotto.

Errori di intestazione della richiesta

Tutte le chiamate API in Platform richiede intestazioni di richiesta specifiche. Per vedere quali intestazioni sono necessarie per i singoli servizi, consulta la sezione Documentazione di riferimento API. Per trovare i valori per le intestazioni di autenticazione richieste, vedi 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 viene visualizzata una Authorization intestazione mancante 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 nel Authorization intestazione non valida. 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 viene visualizzata un'intestazione di chiave API (x-api-key) manca 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 viene visualizzato il valore dell'intestazione della chiave API fornita (x-api-key) non è valida. Assicurati di aver immesso correttamente la chiave prima di riprovare. Se non conosci la tua chiave API, puoi trovarlo nella Console Adobe I/O: in Integrazioni , passa alla Panoramica per 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 org IMS (x-gw-ims-org-id) manca 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 da token di accesso in Authorization header) non è autorizzato a effettuare chiamate a Experience Platform API per l’organizzazione IMS fornita nella x-gw-ims-org-id intestazione. 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 Adobe I/O: in Integrazioni , passa alla Panoramica per 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 presenta una richiesta non valida o mancante Content-Type intestazione. 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 in uno dei due casi seguenti:

• Quando un'intestazione dell'organizzazione IMS non è corretta o non è corretta (x-gw-ims-org-id) viene passato in una richiesta API. Assicurati di includere l’ID corretto della tua organizzazione IMS prima di riprovare.
• Quando l’account (rappresentato dalle credenziali di autenticazione fornite) non è associato, ad Experience Platform, a un profilo di prodotto. Segui i passaggi seguenti generazione delle credenziali di accesso nell’esercitazione sull’autenticazione dell’API Platform per aggiungere Platform al tuo account e aggiornare di conseguenza le credenziali di autenticazione.

Directory di risoluzione dei problemi del servizio

Di seguito è riportato un elenco delle guide per la risoluzione dei problemi e la 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 delle singole persone Platform servizi. 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.