Platform Domande frequenti e guida alla risoluzione dei problemi

Questo documento contiene le risposte alle domande più frequenti su Adobe Experience Platform e una guida di alto livello per la risoluzione dei problemi relativi agli errori più comuni che possono verificarsi in qualsiasi API Experience Platform. Per le guide alla risoluzione dei problemi dei singoli servizi Platform, vedere la directory per la risoluzione dei problemi dei servizi di seguito.

Domande frequenti faq

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

Cosa sono le API Experience Platform? what-are-experience-platform-apis

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

Come si formatta una richiesta API? how-do-i-format-an-api-request

I formati di richiesta variano a seconda dell'API Platform utilizzata. Il modo migliore per scoprire come strutturare le chiamate API è seguire gli esempi forniti nella documentazione del servizio Platform specifico che si sta utilizzando.

Per ulteriori informazioni sulla formattazione delle richieste API, consulta la guida introduttiva all'API Platform lettura di chiamate API di esempio.

Qual è la mia organizzazione? what-is-my-ims-organization

Un'organizzazione è una rappresentazione Adobe di un cliente. Tutte le soluzioni Adobe concesse in licenza sono integrate con questa organizzazione del cliente. Quando un'organizzazione ha diritto a Experience Platform, può assegnare l'accesso agli sviluppatori. L'ID organizzazione (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, accedi alla sezione Panoramica per trovare una particolare integrazione per l'ID in Credenziali client. Per informazioni dettagliate su come eseguire l'autenticazione in Platform, vedere esercitazione sull'autenticazione.

Dove posso trovare la mia chiave API? where-can-i-find-my-api-key

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

Come si ottiene un token di accesso? how-do-i-get-an-access-token

I token di accesso sono necessari nell’intestazione Autorizzazione di tutte le chiamate API. Possono essere generati utilizzando un comando CURL, a condizione che tu abbia accesso a un’integrazione per un’organizzazione. I token di accesso sono validi solo per 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, consulta l'esercitazione sull'autenticazione.

Come si utilizzano i parametri di query? how-do-i-user-query-parameters

Alcuni endpoint API Platform 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 il simbolo del punto interrogativo (?) seguito da uno o più parametri di query nel 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 viene rappresentata nella documentazione una richiesta che utilizza più parametri di query.

Esempi di parametri di query comunemente utilizzati includono:

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 relativa al servizio.

Come si indica un campo JSON da aggiornare in una richiesta PATCH? how-do-i-indicate-a-json-field-to-update-in-a-patch-request

Molte operazioni PATCH nelle API Platform utilizzano 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, consulta la guida sui concetti fondamentali dell'API.

Posso usare Postman per effettuare chiamate alle API Platform? how-do-i-use-postman-to-make-calls-to-platform-apis

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

Requisiti di sistema per Platform what-are-the-system-requirements-for-platform

A seconda che si utilizzi l’interfaccia o l’API, si applicano i seguenti requisiti di sistema:

Per operazioni basate sull'interfaccia utente:

Per interazioni con API e sviluppatori:

Errori e risoluzione problemi errors-and-troubleshooting

Di seguito è riportato un elenco di errori che possono verificarsi quando si utilizza un servizio Experience Platform. Per le guide alla risoluzione dei problemi dei singoli servizi Platform, vedere la directory per la risoluzione dei problemi dei servizi di seguito.

Codici di stato API api-status-codes

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

Errori di intestazione della richiesta request-header-errors

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, vedere l'esercitazione sull'autenticazione. Se una di queste intestazioni risulta mancante o non valida durante una chiamata API, possono verificarsi gli errori seguenti.

Token OAuth mancante oauth-token-is-missing

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

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

Token OAuth non valido oauth-token-is-not-valid

{
    "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. Verificare che il token sia stato immesso correttamente oppure generare un nuovo token nella console Adobe I/O.

È richiesta una chiave API api-key-is-required

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

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

Chiave API non valida api-key-is-invalid

{
    "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) fornita non è valido. Prima di riprovare, assicurati di aver immesso correttamente la chiave. Se non conosci la tua chiave API, puoi trovarla 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 missing-header

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

Questo messaggio di errore viene visualizzato quando manca un'intestazione organizzazione (x-gw-ims-org-id) in una richiesta API. Prima di riprovare, assicurati che l’intestazione sia inclusa nell’ID dell’organizzazione.

Profilo non valido profile-is-not-valid

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

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

Errore di aggiornamento tag refresh-etag-error

{
"errorMessage":"Supplied version=[\\\\\\\"a200a2a3-0000-0200-0000-123178f90000\\\\\\\"] does not match the current version on entity=[\\\\\\\"a200cdb2-0000-0200-0000-456179940000\\\\\\\"]"
}

Se è stata apportata una modifica a un’entità di origine o di destinazione come flusso, connessione, connettore di origine o connessione di destinazione da parte di un altro chiamante API, è possibile che venga visualizzato un errore e-mail. A causa della mancata corrispondenza delle versioni, la modifica che stai tentando di apportare non verrà applicata all’ultima versione dell’entità.

Per risolvere questo problema, è necessario recuperare nuovamente l'entità, assicurarsi che le modifiche siano compatibili con la nuova versione dell'entità, quindi inserire il nuovo etag nell'intestazione If-Match e infine eseguire la chiamata API.

Tipo di contenuto valido non specificato valid-content-type-not-specified

{
    "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 POST, PUT o PATCH contiene un'intestazione Content-Type non valida o mancante. Verificare che l'intestazione sia inclusa nella richiesta e che il relativo valore sia application/json.

Area geografica utente mancante user-region-is-missing

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

Questo messaggio di errore viene visualizzato in uno dei due casi seguenti:

Directory di risoluzione dei problemi del servizio service-troubleshooting-directory

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