Il Amazon Kinesis è disponibile nel catalogo delle origini per gli utenti che hanno acquistato Real-time Customer Data Platform Ultimate.
Questo tutorial illustra i passaggi necessari per la connessione Amazon Kinesis (in seguito denominati "Kinesis") per l'Experience Platform, utilizzando Flow Service API.
Questa guida richiede una buona conoscenza dei seguenti componenti di Adobe Experience Platform:
Le sezioni seguenti forniscono informazioni aggiuntive che è necessario conoscere per connettersi correttamente Kinesis alla piattaforma utilizzando Flow Service API.
Per ottenere Flow Service per connettersi con Amazon Kinesis account, è necessario fornire valori per le seguenti proprietà di connessione:
Credenziali | Descrizione |
---|---|
accessKeyId |
L’ID della chiave di accesso è la metà della coppia di chiavi di accesso utilizzata per autenticare il Kinesis da un account a Platform. |
secretKey |
La chiave di accesso segreta è l’altra metà della coppia di chiavi di accesso utilizzata per autenticare il Kinesis da un account a Platform. |
region |
L’area geografica per il tuo Kinesis account. Consulta la guida su aggiunta di indirizzi IP all’elenco consentiti per ulteriori informazioni sulle aree geografiche. |
connectionSpec.id |
La specifica di connessione restituisce le proprietà del connettore di un'origine, incluse le specifiche di autenticazione relative alla creazione delle connessioni di base e di origine. Il Kinesis ID specifica di connessione: 86043421-563b-46ec-8e6c-e23184711bf6 . |
Per ulteriori informazioni su Kinesis chiavi di accesso e come generarle, fai riferimento a questo AWS guida alla gestione delle chiavi di accesso per gli utenti IAM.
Per informazioni su come effettuare correttamente chiamate alle API di Platform, consulta la guida su introduzione alle API di Platform.
Il primo passaggio nella creazione di una connessione sorgente consiste nell’autenticare Kinesis e generare un ID di connessione di base. Un ID di connessione di base consente di esplorare e navigare tra i file dall’interno dell’origine e identificare elementi specifici da acquisire, incluse informazioni relative ai tipi di dati e ai formati.
Per creare un ID di connessione di base, effettua una richiesta POST al /connections
endpoint durante la fornitura del Kinesis credenziali di autenticazione come parte dei parametri della richiesta.
Formato API
POST /connections
Richiesta
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/connections' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "Amazon Kinesis connection",
"description": "Connector for Amazon Kinesis",
"providerId": "521eee4d-8cbe-4906-bb48-fb6bd4450033",
"auth": {
"specName": "Aws Kinesis authentication credentials",
"params": {
"accessKeyId": "{ACCESS_KEY_ID}",
"secretKey": "{SECRET_KEY}",
"region": "{REGION}"
}
},
"connectionSpec": {
"id": "86043421-563b-46ec-8e6c-e23184711bf6",
"version": "1.0"
}
}'
Proprietà | Descrizione |
---|---|
auth.params.accessKeyId |
ID della chiave di accesso per Kinesis account. |
auth.params.secretKey |
Chiave di accesso segreta per Kinesis account. |
auth.params.region |
L’area geografica per il tuo Kinesis account. |
connectionSpec.id |
Il Kinesis ID specifica di connessione: 86043421-563b-46ec-8e6c-e23184711bf6 |
Risposta
In caso di esito positivo, la risposta restituisce i dettagli della connessione di base appena creata, incluso il relativo identificatore univoco (id
). Questo ID è necessario nel passaggio successivo per creare una connessione sorgente.
{
"id": "4cb0c374-d3bb-4557-b139-5712880adc55",
"etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}
Una connessione di origine crea e gestisce la connessione all’origine esterna da cui vengono acquisiti i dati. Una connessione di origine è costituita da informazioni quali origine dati, formato dati e ID della connessione di origine necessari per creare un flusso di dati. Un'istanza della connessione di origine è specifica di un tenant e di un'organizzazione.
Per creare una connessione sorgente, effettua una richiesta POST al /sourceConnections
endpoint del Flow Service API.
Formato API
POST /sourceConnections
Richiesta
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/sourceConnections' \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-H 'Content-Type: application/json' \
-d '{
"name": "AWS Kinesis source connection",
"description": "A source connection for AWS Kinesis",
"baseConnectionId": "4cb0c374-d3bb-4557-b139-5712880adc55",
"connectionSpec": {
"id": "86043421-563b-46ec-8e6c-e23184711bf6",
"version": "1.0"
},
"data": {
"format": "json"
},
"params": {
"stream": "{STREAM}",
"dataType": "raw",
"reset": "latest"
}
}'
Proprietà | Descrizione |
---|---|
name |
Nome della connessione di origine. Assicurati che il nome della connessione sorgente sia descrittivo, in quanto può essere utilizzato per cercare informazioni sulla connessione sorgente. |
description |
Valore facoltativo che è possibile fornire per includere ulteriori informazioni sulla connessione di origine. |
baseConnectionId |
L’ID della connessione di base Kinesis origine generata nel passaggio precedente. |
connectionSpec.id |
ID della specifica di connessione fissa per Kinesis. Questo ID è: 86043421-563b-46ec-8e6c-e23184711bf6 |
data.format |
Il formato del Kinesis i dati che desideri acquisire. Attualmente, l’unico formato di dati supportato è json . |
params.stream |
Nome del flusso di dati da cui estrarre i record. |
params.dataType |
Questo parametro definisce il tipo di dati che viene acquisito. I tipi di dati supportati includono: raw e xdm . |
params.reset |
Questo parametro definisce la modalità di lettura dei dati. Utilizzare latest per iniziare a leggere dai dati più recenti e utilizzare earliest per iniziare a leggere dai primi dati disponibili nel flusso. |
Risposta
In caso di esito positivo, la risposta restituisce l’identificatore univoco (id
) della connessione sorgente appena creata. Questo ID è richiesto nell’esercitazione successiva per creare un flusso di dati.
{
"id": "e96d6135-4b50-446e-922c-6dd66672b6b2",
"etag": "\"66013508-0000-0200-0000-5f6e2ae70000\""
}
Seguendo questa esercitazione, hai creato una Kinesis connessione sorgente tramite Flow Service API. Puoi utilizzare questo ID connessione sorgente nell’esercitazione successiva per creare un flusso di dati in streaming utilizzando Flow Service API.