Platform Domande frequenti e guida alla risoluzione dei problemi

Ultimo aggiornamento: 2023-11-15
  • Creato per:
  • Developer
    User
    Admin
    Leader

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

Domande frequenti

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

Cosa sono Experience Platform API?

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

Come si formatta una richiesta API?

I formati delle richieste variano a seconda della Platform API in uso. Il modo migliore per imparare a strutturare le chiamate API è seguire insieme agli esempi forniti nella documentazione per le specifiche Platform servizio in uso.

Per ulteriori informazioni sulla formazione delle richieste API, consulta la guida introduttiva all’API della piattaforma lettura di chiamate API di esempio sezione.

Qual è la mia organizzazione?

Un’organizzazione è una rappresentazione di Adobe di un cliente. Tutte le soluzioni di Adobe concesse in licenza sono integrate con questa organizzazione del cliente. Quando un’organizzazione ha il diritto di Experience Platform, può assegnare l’accesso agli sviluppatori. 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 il Console Adobe Developer: nel Integrazioni , passare alla scheda Panoramica per una particolare integrazione per trovare l’ID in Credenziali client. Per informazioni dettagliate su come eseguire l’autenticazione in Platform, vedere tutorial sull’autenticazione.

Dove posso trovare la mia chiave API?

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

Come si ottiene 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, 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, vedi tutorial 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 (?), seguito da uno o più parametri di query utilizzando 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 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?

Molte operazioni PATCH in Platform Le API utilizzano Puntatore JSON stringhe per indicare le proprietà JSON da aggiornare. In genere sono inclusi nei payload di richiesta tramite Patch JSON formato. Consulta la Guida di base sulle API per informazioni dettagliate sulla sintassi richiesta per queste tecnologie.

Posso utilizzare Postman per effettuare chiamate a Platform API?

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

Requisiti di sistema per Platform?

A seconda che si utilizzi l’interfaccia o l’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, le versioni principali attuali 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 il supporto per la terza versione più recente viene rimosso.
  • Tutti i browser devono avere cookie e JavaScript abilitati.

Per interazioni con API e sviluppatori:

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

Errori e risoluzione problemi

Di seguito è riportato un elenco di errori che è possibile riscontrare durante l’utilizzo di Experience Platform servizio. Per guide alla risoluzione dei problemi su singoli Platform servizi, consulta directory di risoluzione dei problemi del servizio di seguito.

Codici di stato API

I seguenti codici di stato possono essere rilevati in qualsiasi Experience Platform API. 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 in singoli Platform servizi, consultare il directory di risoluzione dei problemi del servizio di seguito.

Codice di stato Descrizione Possibili cause
400 Richiesta non valida La richiesta non è stata costruita correttamente, mancano informazioni sulla chiave e/o contiene una sintassi errata.
401 Autenticazione non riuscita La richiesta non ha superato un controllo di autenticazione. Il token di accesso potrebbe essere mancante o non valido. Consulta la Errori token OAuth per ulteriori dettagli.
403 Non consentito La risorsa è stata trovata, ma non si dispone delle credenziali corrette per visualizzarla.
È probabile che l'errore sia dovuto al fatto che non si dispone del necessario autorizzazioni di controllo degli accessi per accedere o modificare la risorsa. Scopri come ottenere le autorizzazioni di controllo dell'accesso basate su attributi necessarie per utilizzare le API di Platform.

404 Non trovato Impossibile trovare la risorsa richiesta nel server. È possibile che la risorsa sia stata eliminata o che il percorso richiesto non sia stato immesso correttamente.
500 Errore interno del server Si tratta di un errore lato server. Se effettui molte chiamate simultanee, potresti raggiungere il limite API e dover filtrare i risultati. (consultare la Catalog Service Guida secondaria per gli sviluppatori API su filtraggio dei dati per ulteriori informazioni.) Attendi un attimo prima di riprovare a eseguire la richiesta e, se il problema persiste, contatta l’amministratore.

Errori di intestazione della richiesta

Tutte le chiamate API in Platform richiedere intestazioni di richiesta specifiche. Per informazioni sulle intestazioni necessarie per i singoli servizi, vedere Documentazione di riferimento API. Per trovare i valori per le intestazioni di autenticazione richieste, vedi Tutorial sull’autenticazione. Se una di queste intestazioni risulta mancante o non valida durante una chiamata API, possono verificarsi gli errori seguenti.

Token OAuth mancante

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

Questo messaggio di errore viene visualizzato quando Authorization Intestazione mancante in una richiesta API. Prima di riprovare, assicurati 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 in Authorization intestazione non valida. Verifica che il token sia stato immesso correttamente, oppure genera un nuovo token nella console Adobe I/O.

È richiesta una chiave API

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

Questo messaggio di errore viene visualizzato quando un’intestazione di chiave API (x-api-key) non è presente in una richiesta API. Prima di riprovare, assicurati 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 fornita (x-api-key) non è valido. Prima di riprovare, assicurati di aver immesso correttamente la chiave. Se non conosci la tua chiave API, puoi trovarla in Console Adobi I/O: nel Integrazioni , passare alla scheda 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 organizzazione (x-gw-ims-org-id) non è presente in una richiesta API. Prima di riprovare, assicurati che l’intestazione sia inclusa nell’ID dell’organizzazione.

Profilo non valido

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

Questo messaggio di errore viene visualizzato quando l’utente o l’integrazione Adobe I/O (identificata da token di accesso nel Authorization non è autorizzato ad effettuare chiamate a Experience Platform API per l’organizzazione fornite nella x-gw-ims-org-id intestazione. 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 sezione Console Adobi I/O: nel Integrazioni , passare alla scheda Panoramica per un’integrazione specifica per trovare l’ID in Credenziali client.

Errore di aggiornamento tag

{
"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 la nuova e-mail nel If-Match e infine effettua la chiamata API.

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 contiene un valore non valido o mancante Content-Type intestazione. Assicurati che l’intestazione sia inclusa nella richiesta e che il suo valore sia application/json.

Area geografica utente mancante

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

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

  • Se l’intestazione dell’ID organizzazione (x-gw-ims-org-id) viene passato in una richiesta API. Prima di riprovare, assicurati di includere l’ID corretto della tua organizzazione.
  • Quando il tuo account (rappresentato dalle credenziali di autenticazione fornite) non è associato a un profilo di prodotto, ad Experience Platform. Segui i passaggi per generazione delle credenziali di accesso nel tutorial sull’autenticazione API di 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 di guide alla risoluzione dei problemi e documentazione di riferimento API per Experience Platform API. Ogni guida alla risoluzione dei problemi fornisce le risposte alle domande frequenti e alle soluzioni ai problemi specifici dei singoli utenti Platform servizi. 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.

Servizio Documentazione di riferimento API Risoluzione dei problemi
Controllo degli accessi API di controllo degli accessi Guida alla risoluzione dei problemi del controllo degli accessi
Acquisizione dei dati Adobe Experience Platform Batch Ingestion API Guida alla risoluzione dei problemi di acquisizione in batch
Acquisizione dei dati Adobe Experience Platform Streaming Ingestion API Guida alla risoluzione dei problemi di acquisizione in streaming
Adobe Experience Platform Data Science Workspace Sensei Machine Learning API Data Science Workspace guida alla risoluzione dei problemi
Governance dei dati Adobe Experience Platform Policy Service API
Servizio Adobe Experience Platform Identity Identity Service API Identity Service guida alla risoluzione dei problemi
Servizio query Adobe Experience Platform Query Service API Query Service guida alla risoluzione dei problemi
Segmentazione di 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 e 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 relativi alle sandbox

In questa pagina