Documentatie Experience Platform Gids voor Source Connectors

Ultieme

Een Amazon Kinesis bronverbinding maken met de Flow Service API

Laatst bijgewerkt: 16 juli 2024

Onderwerpen:

Gemaakt voor:

Ontwikkelaar

IMPORTANT

De Amazon Kinesis -bron is in de broncatalogus beschikbaar voor gebruikers die Real-time Customer Data Platform Ultimate hebben aangeschaft.

Dit leerprogramma begeleidt u door de stappen om Amazon Kinesis (verder als "Kinesis"worden bedoeld) met Experience Platform te verbinden, gebruikend Flow Service API.

Aan de slag

Deze handleiding vereist een goed begrip van de volgende onderdelen van Adobe Experience Platform:

Bronnen: Experience Platform staat gegevens toe om van diverse bronnen worden opgenomen terwijl het voorzien van u van de capaciteit om, inkomende gegevens te structureren te etiketteren en te verbeteren gebruikend Platform diensten.
Sandboxes: Experience Platform verstrekt virtuele zandbakken die één enkele Platform instantie in afzonderlijke virtuele milieu's verdelen helpen digitale ervaringstoepassingen ontwikkelen en ontwikkelen.

In de volgende secties vindt u aanvullende informatie die u nodig hebt om Kinesis met de API van Flow Service te kunnen verbinden met Platform.

Vereiste referenties verzamelen

Flow Service kan alleen verbinding maken met uw Amazon Kinesis -account als u waarden opgeeft voor de volgende verbindingseigenschappen:

Credentials	Beschrijving
`accessKeyId`	De toegangstoets-id is de helft van het sleutelpaar voor toegang dat wordt gebruikt om uw Kinesis -account te verifiëren bij Platform.
`secretKey`	De geheime toegangstoets is de andere helft van het sleutelpaar voor toegang dat wordt gebruikt om uw Kinesis account te verifiëren bij Platform.
`region`	Het gebied voor uw Kinesis account. Zie de gids op toevoegend IP adressen aan uw lijst van gewenste personenvoor meer informatie over gebieden.
`connectionSpec.id`	De verbindingsspecificatie keert de schakelaareigenschappen van een bron, met inbegrip van authentificatiespecificaties met betrekking tot het creëren van de basis en bronverbindingen terug. De Kinesis -id van de verbindingsspecificatie is: `86043421-563b-46ec-8e6c-e23184711bf6` .

Voor meer informatie over Kinesis toegangstoetsen en hoe te om hen te produceren, verwijs naar deze AWS gids over het beheren van toegangstoetsen voor gebruikers IAM.

Platform-API's gebruiken

Voor informatie over hoe te om vraag aan Platform APIs met succes te maken, zie de gids op begonnen wordt met Platform APIs.

Een basisverbinding maken

De eerste stap bij het maken van een bronverbinding is het verifiëren van de Kinesis -bron en het genereren van een basis-verbindings-id. Met een basis-verbindings-id kunt u bestanden verkennen en door de bestanden navigeren vanuit de bron en specifieke items identificeren die u wilt invoeren, zoals informatie over de gegevenstypen en indelingen.

Als u een basis-verbindings-id wilt maken, vraagt u een POST naar het /connections -eindpunt en geeft u de Kinesis -verificatiegegevens op als onderdeel van de aanvraagparameters.

API formaat

POST /connections

Verzoek

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"
        }
    }'

Eigenschap	Beschrijving
`auth.params.accessKeyId`	De toegangstoets-id voor uw Kinesis -account.
`auth.params.secretKey`	De geheime toegangssleutel voor uw Kinesis account.
`auth.params.region`	Het gebied voor uw Kinesis account.
`connectionSpec.id`	De Kinesis connection specification ID: `86043421-563b-46ec-8e6c-e23184711bf6`

Reactie

Een succesvolle reactie keert details van de pas gecreëerde basisverbinding, met inbegrip van zijn uniek herkenningsteken (id) terug. Deze id is vereist in de volgende stap om een bronverbinding te maken.

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"6507cfd8-0000-0200-0000-5e18fc600000\""
}

Een bronverbinding maken

Een bronverbinding maakt en beheert de verbinding met de externe bron vanwaar gegevens worden ingevoerd. Een bronverbinding bestaat uit informatie zoals gegevensbron, gegevensformaat, en bron identiteitskaart nodig om een gegevensstroom tot stand te brengen. Een bronverbindingsinstantie is specifiek voor een huurder en organisatie.

Als u een bronverbinding wilt maken, vraagt u een POST naar het /sourceConnections -eindpunt van de Flow Service API.

API formaat

POST /sourceConnections

Verzoek

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"
        }
    }'

Eigenschap	Beschrijving
`name`	De naam van de bronverbinding. Zorg ervoor dat de naam van uw bronverbinding beschrijvend is aangezien u dit kunt gebruiken om informatie over uw bronverbinding op te zoeken.
`description`	Een optionele waarde die u kunt opgeven voor meer informatie over uw bronverbinding.
`baseConnectionId`	De basis verbindings-id van de Kinesis -bron die in de vorige stap is gegenereerd.
`connectionSpec.id`	The fixed connection specification ID for Kinesis. Deze id is: `86043421-563b-46ec-8e6c-e23184711bf6`
`data.format`	De indeling van de Kinesis -gegevens die u wilt invoeren. Momenteel is de enige ondersteunde gegevensindeling `json` .
`params.stream`	De naam van de gegevensstroom waaruit records moeten worden opgehaald.
`params.dataType`	Deze parameter bepaalt het type van de gegevens die worden opgenomen. Tot de ondersteunde gegevenstypen behoren: `raw` en `xdm` .
`params.reset`	Deze parameter bepaalt hoe de gegevens worden gelezen. Gebruik `latest` om te beginnen met het lezen van de meest recente gegevens en gebruik `earliest` om te beginnen met het lezen van de eerste beschikbare gegevens in de stream.

Reactie

Een succesvolle reactie keert het unieke herkenningsteken (id) van de pas gecreëerde bronverbinding terug. Deze id is vereist in de volgende zelfstudie om een gegevensstroom te maken.

{
    "id": "e96d6135-4b50-446e-922c-6dd66672b6b2",
    "etag": "\"66013508-0000-0200-0000-5f6e2ae70000\""
}

Volgende stappen

Aan de hand van deze zelfstudie hebt u een Kinesis -bronverbinding gemaakt met de Flow Service API. U kunt deze bron verbindingsidentiteitskaart in het volgende leerprogramma gebruiken om een het stromen dataflow tot stand te brengen gebruikend Flow Service API.

recommendation-more-help