L’acquisizione in streaming ti consente di caricare i dati in Adobe Experience Platform utilizzando endpoint di streaming in tempo reale. Le API di acquisizione in streaming supportano due modalità di convalida, sincrona e asincrona.
Questa guida richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:
Questo tutorial fornisce esempi di chiamate API per dimostrare come formattare le richieste. Questi includono percorsi, intestazioni richieste e payload di richieste formattati correttamente. Viene inoltre fornito il codice JSON di esempio restituito nelle risposte API. Per informazioni sulle convenzioni utilizzate nella documentazione per le chiamate API di esempio, consulta la sezione su come leggere esempi di chiamate API nel Experience Platform guida alla risoluzione dei problemi.
Per effettuare chiamate a Platform , devi prima completare le tutorial sull’autenticazione. Il completamento del tutorial sull’autenticazione fornisce i valori per ciascuna delle intestazioni richieste in tutte Experience Platform Chiamate API, come mostrato di seguito:
{ACCESS_TOKEN}
{API_KEY}
{ORG_ID}
Tutte le risorse in Experience Platform, compresi quelli appartenenti al Schema Registry, sono isolate in specifiche sandbox virtuali. Tutte le richieste a Platform Le API richiedono un’intestazione che specifichi il nome della sandbox in cui verrà eseguita l’operazione:
{SANDBOX_NAME}
Per ulteriori informazioni sulle sandbox in Platform, vedere documentazione di panoramica sulla sandbox.
Tutte le richieste che contengono un payload (POST, PUT, PATCH) richiedono un’intestazione aggiuntiva:
application/json
Streaming Validation Service riguarda la convalida nei seguenti settori:
La convalida sincrona è un metodo di convalida che fornisce un feedback immediato sul motivo per cui un’acquisizione non è riuscita. Tuttavia, in caso di errore, i record che non superano la convalida vengono eliminati e non possono essere inviati a valle. Di conseguenza, la convalida sincrona deve essere utilizzata solo durante il processo di sviluppo. Durante la convalida sincrona, i chiamanti vengono informati sia del risultato della convalida XDM che, se questa non è riuscita, del motivo dell’errore.
Per impostazione predefinita, la convalida sincrona non è attivata. Per abilitarlo, devi passare il parametro di query opzionale syncValidation=true
quando si effettuano chiamate API. Inoltre, la convalida sincrona è attualmente disponibile solo se l'endpoint di flusso si trova nel data center VA7.
Il syncValidation
il parametro query è disponibile solo per il singolo endpoint di messaggio e non può essere utilizzato per l'endpoint batch.
Se un messaggio non riesce durante la convalida sincrona, non verrà scritto nella coda di output, che fornisce un feedback immediato agli utenti.
Le modifiche allo schema potrebbero non essere immediatamente disponibili, poiché sono memorizzate nella cache. Attendere fino a quindici minuti per l'aggiornamento della cache.
Formato API
POST /collection/{CONNECTION_ID}?syncValidation=true
Parametro | Descrizione |
---|---|
{CONNECTION_ID} |
Il id valore della connessione streaming creata in precedenza. |
Richiesta
Invia la seguente richiesta per acquisire i dati all’ingresso dei dati con convalida sincrona:
curl -X POST https://dcs.adobedc.net/collection/{CONNECTION_ID}?syncValidation=true \
-H "Content-Type: application/json" \
-d '{JSON_PAYLOAD}'
Parametro | Descrizione |
---|---|
{JSON_PAYLOAD} |
Il corpo JSON di un dato che desideri acquisire. |
Risposta
Con la convalida sincrona abilitata, una risposta corretta include eventuali errori di convalida riscontrati nel relativo payload:
{
"type": "http://ns.adobe.com/adobecloud/problem/data-collection-service/inlet",
"status": 400,
"title": "Invalid XDM Message Format",
"report": {
"message": "inletId: [6aca7aa2d87ebd6b2780ca5724d94324a14475f140a2b69373dd5c714430dfd4] imsOrgId: [7BF122A65C5B3FE40A494026@AdobeOrg] Message is invalid",
"cause": {
"_streamingValidation": [
{
"schemaLocation": "#",
"pointerToViolation": "#",
"causingExceptions": [
{
"schemaLocation": "#",
"pointerToViolation": "#",
"causingExceptions": [],
"keyword": "additionalProperties",
"message": "extraneous key [workEmail] is not permitted"
},
{
"schemaLocation": "#",
"pointerToViolation": "#",
"causingExceptions": [],
"keyword": "additionalProperties",
"message": "extraneous key [person] is not permitted"
},
{
"schemaLocation": "#/properties/_id",
"pointerToViolation": "#/_id",
"causingExceptions": [],
"keyword": "type",
"message": "expected type: String, found: Long"
}
],
"message": "3 schema violations found"
}
]
}
}
}
La risposta precedente elenca quante violazioni dello schema sono state trovate e quali sono state. Ad esempio, questa risposta indica che le chiavi workEmail
e person
non sono state definite nello schema e pertanto non sono consentite. Inoltre, contrassegna il valore per _id
come errato, poiché nello schema era previsto un string
, ma un long
è stato inserito. Una volta riscontrati cinque errori, il servizio di convalida stop elaborazione del messaggio. Tuttavia, altri messaggi continueranno a essere analizzati.
La convalida asincrona è un metodo di convalida che non fornisce feedback immediati. I dati vengono invece inviati a un batch non riuscito in Data Lake per evitare la perdita di dati. Questi dati non riusciti possono essere recuperati in seguito per ulteriori analisi e ripetizioni. Questo metodo deve essere utilizzato nella produzione. Se non diversamente richiesto, l’acquisizione in streaming funziona in modalità di convalida asincrona.
Formato API
POST /collection/{CONNECTION_ID}
Parametro | Descrizione |
---|---|
{CONNECTION_ID} |
Il id valore della connessione streaming creata in precedenza. |
Richiesta
Invia la seguente richiesta per acquisire i dati all’ingresso dei dati con convalida asincrona:
curl -X POST https://dcs.adobedc.net/collection/{CONNECTION_ID} \
-H "Content-Type: application/json" \
-d '{JSON_PAYLOAD}'
Parametro | Descrizione |
---|---|
{JSON_PAYLOAD} |
Il corpo JSON di un dato che desideri acquisire. |
Non è richiesto alcun parametro di query aggiuntivo, in quanto la convalida asincrona è abilitata per impostazione predefinita.
Risposta
Se la convalida asincrona è abilitata, una risposta corretta restituisce quanto segue:
{
"inletId": "f6ca9706d61de3b78be69e2673ad68ab9fb2cece0c1e1afc071718a0033e6877",
"xactionId": "1555445493896:8600:8",
"receivedTimeMs": 1555445493932,
"syncValidation": {
"skipped": true
}
}
La risposta indica che la convalida sincrona è stata ignorata, in quanto non è stata esplicitamente richiesta.
Questa sezione contiene informazioni sul significato dei vari codici di stato per le risposte per l’acquisizione dei dati.
Codice di stato | Che cosa significa |
---|---|
200 | Operazione riuscita. Per la convalida sincrona, significa che ha superato i controlli di convalida. Per la convalida asincrona, significa che ha ricevuto correttamente solo il messaggio. Gli utenti possono scoprire l’eventuale stato del messaggio osservando il set di dati. |
400 | Errore. Si è verificato un errore nella richiesta. Un messaggio di errore con ulteriori dettagli viene ricevuto da Streaming Validation Services. |
401 | Errore. La richiesta non è autorizzata: dovrai richiedere con un token Bearer. Per ulteriori informazioni su come richiedere l’accesso, consulta esercitazione o questo post di blog. |
500 | Errore. Si è verificato un errore interno del sistema. |
501 | Errore. Ciò significa che la convalida sincrona è non supportate per questa posizione. |
503 | Errore. Il servizio non è al momento disponibile. I clienti devono riprovare almeno tre volte utilizzando una strategia di back-off esponenziale. |