Doelverbindingen bewerken met de Flow Service API

Deze zelfstudie behandelt de stappen voor het bewerken van verschillende componenten van een doelverbinding. Leer hoe te om authentificatiegeloofsbrieven, de uitvoerplaats, en meer bij te werken door Flow Service APIte gebruiken.

Aan de slag get-started

Voor deze zelfstudie moet u een geldige gegevensstroom-id hebben. Als u geen geldige dataflow identiteitskaart hebt, selecteer uw bestemming van keus van de bestemmingscatalogusen volg de stappen die aan worden geschetst verbinden met de bestemmingen activeren gegevensalvorens dit leerprogramma te proberen.

Voor deze zelfstudie hebt u ook een goed inzicht nodig in de volgende onderdelen van Adobe Experience Platform:

De volgende secties bevatten aanvullende informatie die u moet weten om uw gegevensstroom met de Flow Service API te kunnen bijwerken.

API-voorbeeldaanroepen lezen reading-sample-api-calls

Deze zelfstudie biedt voorbeeld-API-aanroepen om aan te tonen hoe uw verzoeken moeten worden opgemaakt. Dit zijn paden, vereiste kopteksten en correct opgemaakte ladingen voor aanvragen. Voorbeeld-JSON die wordt geretourneerd in API-reacties, wordt ook verschaft. Voor informatie over de overeenkomsten die in documentatie voor steekproef API vraag worden gebruikt, zie de sectie op hoe te om voorbeeld API vraagin de het oplossen van problemengids van Experience Platform te lezen.

Waarden verzamelen voor vereiste koppen gather-values-for-required-headers

Om vraag aan Experience Platform APIs te maken, moet u het authentificatieleerprogrammaeerst voltooien. Als u de zelfstudie over verificatie voltooit, krijgt u de waarden voor elk van de vereiste headers in alle Experience Platform API-aanroepen, zoals hieronder wordt getoond:

Alle bronnen in Experience Platform, inclusief die van Flow Service , zijn geïsoleerd naar specifieke virtuele sandboxen. Alle aanvragen aan Experience Platform API's vereisen een header die de naam aangeeft van de sandbox waarin de bewerking plaatsvindt:

Alle verzoeken die een payload (POST, PUT, PATCH) bevatten vereisen een extra media type kopbal:

Gegevens over gegevensstroom opzoeken look-up-dataflow-details

De eerste stap bij het bewerken van uw doelverbinding is het ophalen van gegevens over de gegevensstroom met uw flow-id. U kunt de huidige details van een bestaande gegevensstroom bekijken door een GET- verzoek aan het /flows eindpunt te doen.

TIP

U kunt de gebruikersinterface van Experience Platform gebruiken om de gewenste gegevensstroom-id van een doel op te halen. Ga naar Destinations > Browse en selecteer de gewenste doelgegevensstroom en zoek de doel-id in de rechtertrack. De doel-id is de waarde die u in de volgende stap als stroom-id wilt gebruiken.

API formaat

GET /flows/{FLOW_ID}

Verzoek

Met het volgende verzoek wordt informatie over uw flow-id opgehaald.

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -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}'

Reactie

Een succesvolle reactie keert de huidige details van uw gegevensstroom met inbegrip van zijn versie, uniek herkenningsteken (id), en andere relevante informatie terug. Het meest relevant voor deze zelfstudie zijn de doel-verbinding en basis-verbindings-id's die in de onderstaande reactie worden gemarkeerd. U gebruikt deze id's in de volgende secties om verschillende componenten van de doelverbinding bij te werken.

{
   "items":[
      {
         "id":"226fb2e1-db69-4760-b67e-9e671e05abfc",
         "createdAt":"{CREATED_AT}",
         "updatedAt":"{UPDATED_BY}",
         "createdBy":"{CREATED_BY}",
         "updatedBy":"{UPDATED_BY}",
         "createdClient":"{CREATED_CLIENT}",
         "updatedClient":"{UPDATED_CLIENT}",
         "sandboxId":"{SANDBOX_ID}",
         "sandboxName":"prod",
         "imsOrgId":"{ORG_ID}",
         "name":"2021 winter campaign",
         "description":"ACME company holiday campaign for high fidelity customers",
         "flowSpec":{
            "id":"71471eba-b620-49e4-90fd-23f1fa0174d8",
            "version":"1.0"
         },
         "state":"enabled",
         "version":"\"8b0351ca-0000-0200-0000-61c4d6700000\"",
         "etag":"\"8b0351ca-0000-0200-0000-61c4d6700000\"",
         "sourceConnectionIds":[
            "5e45582a-5336-4ea1-9ec9-d0004a9f344a"
         ],
         "targetConnectionIds":[
            "8ce3dc63-3766-4220-9f61-51d2f8f14618"
         ],
         "inheritedAttributes":{
            "sourceConnections":[
               {
                  "id":"5e45582a-5336-4ea1-9ec9-d0004a9f344a",
                  "connectionSpec":{
                     "id":"8a9c3494-9708-43d7-ae3f-cda01e5030e1",
                     "version":"1.0"
                  },
                  "baseConnection":{
                     "id":"0a82f29f-b457-47f7-bb30-33856e2ae5aa",
                     "connectionSpec":{
                        "id":"8a9c3494-9708-43d7-ae3f-cda01e5030e1",
                        "version":"1.0"
                     }
                  },
                  "typeInfo":{
                     "type":"ProfileFragments",
                     "id":"ups"
                  }
               }
            ],
            "targetConnections":[
               {
                  "id":"8ce3dc63-3766-4220-9f61-51d2f8f14618",
                  "connectionSpec":{
                     "id":"0b23e41a-cb4a-4321-a78f-3b654f5d7d97",
                     "version":"1.0"
                  },
                  "baseConnection":{
                     "id":"7fbf542b-83ed-498f-8838-8fde0c4d4d69",
                     "connectionSpec":{
                        "id":"0b23e41a-cb4a-4321-a78f-3b654f5d7d97",
                        "version":"1.0"
                     }
                  }
               }
            ]
         },
         "transformations":[
            "shortened for brevity"
         ]
      }
   ]

Doelverbindingscomponenten bewerken (opslaglocatie en andere componenten) patch-target-connection

De componenten van een doelverbinding verschillen door bestemming. Voor Amazon S3 -doelen kunt u bijvoorbeeld het emmertje en het pad bijwerken waar bestanden worden geëxporteerd. Voor Pinterest -doelen kunt u Pinterest Advertiser ID bijwerken en voor Google Customer Match kunt u Pinterest Account ID bijwerken.

Als u componenten van een doelverbinding wilt bijwerken, voert u een PATCH -aanvraag uit naar het /targetConnections/{TARGET_CONNECTION_ID} -eindpunt terwijl u uw doel-verbindings-id, -versie en de nieuwe waarden opgeeft die u wilt gebruiken. Herinner me, kreeg u uw identiteitskaart van de doelverbinding in de vorige stap, toen u een bestaande gegevensstroom aan uw gewenste bestemming inspecteerde.

Hieronder staan enkele voorbeelden van het bijwerken van parameters in de specificaties van de doelverbinding voor verschillende typen doelen. Maar de algemene regel om parameters voor om het even welke bestemming bij te werken is als volgt:

Haal de gegevensstroom-id op van de verbinding > verkrijg de doel-verbindings-id > PATCH de doelverbinding met bijgewerkte waarden voor de gewenste parameters.

API formaat

PATCH /targetConnections/{TARGET_CONNECTION_ID}

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/targetConnections/b2cb1407-3114-441c-87ea-2c1a3c84d0b0' \
    -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 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
  {
    "op": "replace",
    "path": "/params",
    "value": {
      "bucketName": "newBucketName",
      "path": "updatedPath"
    }
  }
]'

{
    "id": "b2cb1407-3114-441c-87ea-2c1a3c84d0b0",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/targetConnections/b2cb1407-3114-441c-87ea-2c1a3c84d0b0' \
    -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 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
  {
    "op": "add",
    "path": "/params/appendSegmentId",
    "value": true
  }
]'

{
    "id": "b2cb1407-3114-441c-87ea-2c1a3c84d0b0",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/targetConnections/b2cb1407-3114-441c-87ea-2c1a3c84d0b0' \
    -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 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
  {
    "op": "replace",
    "path": "/params",
    "value": {
      "advertiser_id": "1234567890"
    }
  }
]'

{
    "id": "b2cb1407-3114-441c-87ea-2c1a3c84d0b0",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

Basisverbindingscomponenten bewerken (verificatieparameters en andere componenten) patch-base-connection

Bewerk de basisverbinding wanneer u de referenties van een doel wilt bijwerken. De componenten van een basisverbinding verschillen door bestemming. Voor Amazon S3 -doelen kunt u bijvoorbeeld de toegangstoets en de geheime sleutel bijwerken naar uw Amazon S3 -locatie.

Als u componenten van een basisverbinding wilt bijwerken, voert u een PATCH -aanvraag uit naar het /connections -eindpunt terwijl u de id, versie en de nieuwe waarden voor de basisverbinding opgeeft die u wilt gebruiken.

Herinner me, u uw identiteitskaart van de basisverbinding in a vorige stapkreeg, toen u een bestaande dataflow aan uw gewenste bestemming voor de parameter baseConnection inspecteerde.

Hieronder staan enkele voorbeelden van het bijwerken van parameters in de specificatie van de basisverbinding voor verschillende soorten doelen. Maar de algemene regel om parameters voor om het even welke bestemming bij te werken is als volgt:

Haal de gegevensstroom-id op van de verbinding > verkrijg de id van de basisverbinding > PATCH de basisverbinding met bijgewerkte waarden voor de gewenste parameters.

API formaat

PATCH /connections/{BASE_CONNECTION_ID}

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/targetConnections/b2cb1407-3114-441c-87ea-2c1a3c84d0b0' \
    -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 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
  {
    "op": "add",
    "path": "/auth/params",
    "value": {
      "accessId": "exampleAccessId",
      "secretKey": "exampleSecretKey"
    }
  }
]'

{
    "id": "b2cb1407-3114-441c-87ea-2c1a3c84d0b0",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/targetConnections/b2cb1407-3114-441c-87ea-2c1a3c84d0b0' \
    -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 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
  {
    "op": "add",
    "path": "/auth/params",
    "value": {
      "connectionString": "updatedString"
    }
  }
]'

{
    "id": "b2cb1407-3114-441c-87ea-2c1a3c84d0b0",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

API-foutafhandeling api-error-handling

De API-eindpunten in deze zelfstudie volgen de algemene beginselen van het Experience Platform API-foutbericht. Verwijs naar API statuscodesen de fouten van de verzoekkopbalin de het oplossen van problemengids van Experience Platform voor meer informatie bij het interpreteren van foutenreacties.

Volgende stappen next-steps

Aan de hand van deze zelfstudie hebt u geleerd hoe u verschillende componenten van een doelverbinding kunt bijwerken met de Flow Service API. Voor meer informatie over bestemmingen, zie het overzicht van bestemmingen.