Een Amazon S3-basisverbinding maken met de Flow Service API

Een basisverbinding vertegenwoordigt de geverifieerde verbinding tussen een bron en Adobe Experience Platform.

Dit leerprogramma begeleidt u door de stappen om een basisverbinding voor Amazon S3 tot stand te brengen (verder die als " S3 wordt bedoeld") 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.
  • Sandboxen: 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 moet weten als u verbinding wilt maken met een S3 -opslag met de Flow Service API.

Vereiste referenties verzamelen

Flow Service kan alleen verbinding maken met uw S3 -opslag als u waarden opgeeft voor de volgende verbindingseigenschappen:

Credentials
Beschrijving
s3AccessKey
De toegangs belangrijkste identiteitskaart voor uw S3 emmer.
s3SecretKey
De geheime sleutel-id voor uw S3 emmertje.
serviceUrl
(Optioneel) Het aangepaste S3 -eindpunt waarmee verbinding moet worden gemaakt. Dit veld is vereist wanneer uw S3 emmertje regiospecifiek is. De notatie voor serviceUrl is: https://s3.{REGION}.amazonaws.com/) .
bucketName
Het emmertje S3 bevat uw gegevens en de bijbehorende beschrijvende metagegevens. De naam van de S3 emmer moet tussen de drie en 63 tekens lang zijn en moet beginnen en eindigen met een letter of een getal. De naam van de emmertje kan slechts kleine letters, aantallen, of koppeltekens (-) hebben, en kan niet als IP adres worden geformatteerd.
folderPath
Het pad naar de map in de S3 emmer waarin uw gegevens zijn opgeslagen. Deze referentie is vereist wanneer de gebruiker toegang heeft beperkt.
s3SessionToken
(Optioneel) Een tijdelijke token voor de korte termijn waarmee u gebruikers in niet-vertrouwde omgevingen tijdelijk toegang kunt geven tot uw S3 -bronnen. Zie het S3 overzichtvoor meer informatie.
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 verbindingsspecificatie-id voor S3 is: ecadc60c-7455-4d87-84dc-2a0e293d997b .

Voor meer informatie bij het worden begonnen, bezoek dit Amazon Web Services document.

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

Een basisverbinding behoudt informatie tussen uw bron en Platform, met inbegrip van de de authentificatiegeloofsbrieven van uw bron, de huidige staat van de verbinding, en uw unieke identiteitskaart van de basisverbinding. Met de ID van de basisverbinding kunt u bestanden verkennen en door bestanden navigeren vanuit uw bron en kunt u de specifieke items identificeren die u wilt opnemen, inclusief informatie over hun gegevenstypen en indelingen.

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

API formaat

POST /connections

Verzoek

Met de volgende aanvraag wordt een basisverbinding voor S3 gemaakt:

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 S3 base connection",
        "description": "Amazon S3 base connection with temporary session token",
        "auth": {
            "specName": "Access Key",
            "params": {
                "s3AccessKey": "{S3_ACCESS_KEY}",
                "s3SecretKey": "{S3_SECRET_KEY}",
                "s3SessionToken": "{S3_SESSION_TOKEN}
            }
        },
        "connectionSpec": {
            "id": "ecadc60c-7455-4d87-84dc-2a0e293d997b",
            "version": "1.0"
        }
    }'
Eigenschap
Beschrijving
auth.params.s3AccessKey
De toegangstoets die aan uw S3 emmertje is gekoppeld.
auth.params.s3SecretKey
Uw geheime sleutel die aan uw S3 emmer is gekoppeld.
auth.params.s3SessionToken
(Optioneel) De tijdelijke token S3 voor de korte termijn die wordt gebruikt om toegang te krijgen tot uw emmertje.
connectionSpec.id
De S3 connection specification ID: ecadc60c-7455-4d87-84dc-2a0e293d997b

Reactie

Een succesvolle reactie keert details van de pas gecreëerde verbinding, met inbegrip van zijn uniek herkenningsteken (id) terug. Deze id is vereist om uw opslag te verkennen in de volgende zelfstudie.

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"1700d77b-0000-0200-0000-5e3b41a10000\""
}

Volgende stappen

Door deze zelfstudie te volgen, hebt u een S3-verbinding gemaakt met behulp van API's en is een unieke id opgehaald als onderdeel van de hoofdtekst van de reactie. U kunt deze verbindingsidentiteitskaart gebruiken om wolkenopslag te onderzoeken gebruikend de Dienst API van de Stroom.

Bijlage

In de volgende sectie vindt u aanvullende informatie over het gebruik van de S3 -bron.

Uw S3 sessietoken bijwerken

s3SessionToken is tijdelijk en moet worden bijgewerkt wanneer het verloopt. U kunt het sessietoken dat aan uw basisverbinding is gekoppeld, bijwerken door een PATCH-aanvraag in te dienen bij de Flow Service API. Zie het S3 overzichtvoor meer informatie over tijdelijke veiligheidsgeloofsbrieven voor S3.

IMPORTANT
De header If-Match is vereist wanneer een PATCH-aanvraag wordt ingediend. De waarde voor deze header is de unieke tag van de verbinding die u wilt bijwerken.

API formaat

PATCH /connections

Verzoek

Met de volgende aanvraag wordt een basisverbinding voor S3 gemaakt:

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/connections/4cb0c374-d3bb-4557-b139-5712880adc55' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'Content-Type: application/json' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}' \
    -H 'If-Match: "1700d77b-0000-0200-0000-5e3b41a10000"'
    -d '[
        {
            "op": "replace",
            "path": "/auth/params/s3SessionToken",
            "value": "{SESSION_TOKEN}"
        }
    ]'
Parameter
Beschrijving
op
De verrichtingsvraag die wordt gebruikt om de actie te bepalen nodig om de verbinding bij te werken. Bewerkingen zijn: add , replace en remove .
path
Het pad van de parameter die moet worden bijgewerkt.
value
De nieuwe waarde waarmee u de parameter wilt bijwerken.

Reactie

Een geslaagde reactie retourneert uw basis-verbindings-id en een bijgewerkt label. U kunt de update verifiëren door een aanvraag voor een GET in te dienen bij de Flow Service API en tegelijk uw verbinding-id op te geven.

{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"3600e378-0000-0200-0000-5f40212f0000\""
}
recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089