Een marketingautomatiseringssysteem verkennen met de API van Flow Service

Flow Service wordt gebruikt voor het verzamelen en centraliseren van klantgegevens uit verschillende bronnen in Adobe Experience Platform. De service biedt een gebruikersinterface en RESTful API waaruit alle ondersteunde bronnen kunnen worden aangesloten.

In deze zelfstudie wordt de API van Flow Service gebruikt om systemen voor marketingautomatisering te verkennen.

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 Experience Platform diensten.
  • ​ Sandboxen ​: Experience Platform verstrekt virtuele zandbakken die één enkele Experience Platform instantie in afzonderlijke virtuele milieu's verdelen helpen digitale ervaringstoepassingen ontwikkelen en ontwikkelen.

De volgende secties bevatten aanvullende informatie die u moet weten om verbinding te kunnen maken met een marketingautomatiseringssysteem dat de Flow Service API gebruikt.

Vereiste referenties verzamelen

Deze zelfstudie vereist dat u een geldige verbinding hebt met de marketingtoepassing van derden waarvan u gegevens wilt invoeren. Een geldige verbinding heeft betrekking op de verbindingsspecificatie-id en de verbinding-id van uw toepassing. Meer informatie over het creëren van een marketing automatiseringsverbinding en het terugwinnen van deze waarden kan in ​ worden gevonden een marketing automatiseringsbron aan Experience Platform ​ leerprogramma verbinden.

API-voorbeeldaanroepen lezen

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 vraag ​ in de Experience Platform het oplossen van problemengids te lezen.

Waarden verzamelen voor vereiste koppen

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

  • Autorisatie: Drager {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

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

  • x-sandbox-name: {SANDBOX_NAME}

Alle verzoeken die een lading (POST, PUT, PATCH) bevatten vereisen een extra media typekopbal:

  • Inhoudstype: application/json

Uw gegevenstabellen verkennen

Met de basisverbinding voor uw marketingautomatiseringssysteem kunt u uw gegevenstabellen verkennen door GET-aanvragen uit te voeren. Gebruik de volgende aanroep om het pad te zoeken van de tabel die u wilt inspecteren of waarin u wilt opnemen Experience Platform.

API formaat

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
Parameter
Beschrijving
{BASE_CONNECTION_ID}
De id van de basisverbinding voor uw marketingautomatiseringssysteem.

Verzoek

curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/2fce94c1-9a93-4971-8e94-c19a93097129/explore?objectType=root' \
    -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 is een serie van lijsten van aan uw systeem van de marketing automatisering. Zoek de tabel die u wilt opnemen in Experience Platform en neem nota van de eigenschap path ervan, aangezien u deze in de volgende stap moet opgeven om de structuur te inspecteren.

[
    {
        "type": "table",
        "name": "Hubspot.All_Deals",
        "path": "Hubspot.All_Deals",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Hubspot.Blog_Authors",
        "path": "Hubspot.Blog_Authors",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Hubspot.Blog_Comments",
        "path": "Hubspot.Blog_Comments",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Hubspot.Contacts",
        "path": "Hubspot.Contacts",
        "canPreview": true,
        "canFetchSchema": true
    },
]

De structuur van een tabel controleren

Om de structuur van een lijst van uw marketing automatiseringssysteem te inspecteren, voer een verzoek van GET uit terwijl het specificeren van de weg van een lijst als vraagparameter.

API formaat

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}
Parameter
Beschrijving
{BASE_CONNECTION_ID}
De verbinding-id voor uw marketingautomatiseringssysteem.
{TABLE_PATH}
Het pad van een tabel in uw marketingautomatiseringssysteem.

Verzoek

curl -X GET \
    'http://platform.adobe.io/data/foundation/flowservice/connections/2fce94c1-9a93-4971-8e94-c19a93097129/explore?objectType=table&object=Hubspot.Contacts' \
    -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 geslaagde reactie retourneert de structuur van een tabel. De details betreffende elk van de kolommen van de lijst worden gevestigd binnen elementen van de columns serie.

{
    "format": "flat",
    "schema": {
        "columns": [
            {
                "name": "Properties_Firstname_Value",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Properties_Lastname_Value",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "Added_At",
                "type": "string",
                "meta:xdmType": "date-time",
                "xdm": {
                    "type": "string",
                    "format": "date-time"
                }
            },
            {
                "name": "Portal_Id",
                "type": "string",
                "xdm": {
                    "type": "string"
                }
            },
        ]
    }
}

Volgende stappen

Aan de hand van deze zelfstudie hebt u uw systeem voor marketingautomatisering verkend, het pad van de tabel gevonden die u wilt doorgeven aan Experience Platform en informatie gekregen over de structuur ervan. U kunt deze informatie in het volgende leerprogramma gebruiken ​ gegevens van uw marketing automatiseringssysteem verzamelen en het brengen in Experience Platform ​.

recommendation-more-help
337b99bb-92fb-42ae-b6b7-c7042161d089