Verbinding maken met Experience Platform via de Flow Service APIMicrosoft Dynamics

Lees deze gids om te leren hoe u uw Microsoft Dynamics bron aan Adobe Experience Platform kunt 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 de diensten van Experience Platform.
  • ​ Sandboxes ​: Experience Platform verstrekt virtuele zandbakken die één enkele instantie van Experience Platform in afzonderlijke virtuele milieu's verdelen helpen digitale ervaringstoepassingen ontwikkelen en ontwikkelen.

Experience Platform API's gebruiken

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

De volgende secties bevatten aanvullende informatie die u moet weten om Experience Platform met succes te kunnen verbinden met een Dynamics-account met behulp van de Flow Service API.

Vereiste referenties verzamelen

Flow Service kan alleen verbinding maken met Dynamics als u waarden opgeeft voor de volgende verbindingseigenschappen:

Basisauthentificatie
table 0-row-2 1-row-2 2-row-2 3-row-2
Credentials Beschrijving
serviceUri De service-URL van uw Dynamics -instantie.
username De gebruikersnaam voor uw Dynamics -gebruikersaccount.
password Het wachtwoord voor uw Dynamics -account.
dienst-hoofd en zeer belangrijke authentificatie
table 0-row-2 1-row-2 2-row-2
Credentials Beschrijving
servicePrincipalId De client-id van uw Dynamics -account. Deze ID wordt vereist wanneer het gebruiken van de dienst hoofd en op sleutel-gebaseerde authentificatie.
servicePrincipalKey De geheime sleutel van de dienst belangrijkste geheim. Deze referentie wordt vereist wanneer het gebruiken van de dienst belangrijkste en op sleutel-gebaseerde authentificatie.

Voor meer informatie bij het worden begonnen, verwijs naar ​ dit Dynamics document ​.

Een basisverbinding maken

TIP
Nadat u een Dynamics basisverbinding hebt gemaakt, kunt u het verificatietype niet wijzigen. Als u het verificatietype wilt wijzigen, moet u een nieuwe basisverbinding maken.

Een basisverbinding behoudt informatie tussen uw bron en Experience Platform, met inbegrip van de verificatiereferenties van uw bron, de huidige status 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-aanvraag naar het /connections -eindpunt en geeft u de Dynamics -verificatiegegevens op als onderdeel van de aanvraagparameters.

API formaat

POST /connections
Basisauthentificatie

Als u een Dynamics -basisverbinding wilt maken met behulp van basisverificatie, dient u een POST-aanvraag in bij de Flow Service API en geeft u waarden op voor de serviceUri , username en password van de verbinding.

Verzoek

Met de volgende aanvraag wordt een basisverbinding voor een Dynamics -bron gemaakt met behulp van basisverificatie.

accordion
Selecteren om aanvraagvoorbeeld weer te geven
code language-shell
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": "Dynamics connection",
      "description": "Dynamics connection using basic auth",
      "auth": {
          "specName": "Basic Authentication for Dynamics-Online",
          "params": {
              "serviceUri": "{SERVICE_URI}",
              "username": "{USERNAME}",
              "password": "{PASSWORD}"
          }
      },
      "connectionSpec": {
          "id": "38ad80fe-8b06-4938-94f4-d4ee80266b07",
          "version": "1.0"
      }
  }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Eigenschap Beschrijving
auth.params.serviceUri De service-URI die aan uw Dynamics -instantie is gekoppeld.
auth.params.username De gebruikersnaam die aan uw Dynamics -account is gekoppeld.
auth.params.password Het wachtwoord dat aan uw Dynamics account is gekoppeld.
connectionSpec.id De Dynamics connection specification ID: 38ad80fe-8b06-4938-94f4-d4ee80266b07

Reactie

Een succesvolle reactie keert de pas gecreëerde basisverbinding, met inbegrip van zijn uniek herkenningsteken (id) terug.

accordion
Selecteren om reactievoorbeeld weer te geven
code language-json
{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"9e0052a2-0000-0200-0000-5e35tb330000\""
}
de dienst belangrijkste op sleutel-gebaseerde authentificatie

Als u een Dynamics -basisverbinding wilt maken met behulp van service principal key-verificatie, dient u een POST-aanvraag in bij de Flow Service API en geeft u waarden op voor de serviceUri , servicePrincipalId en servicePrincipalKey van uw verbinding.

Verzoek

Met het volgende verzoek wordt een basisverbinding voor een Dynamics -bron gemaakt met behulp van basisverificatie op basis van hoofdsleutels van de service.

accordion
Selecteren om aanvraagvoorbeeld weer te geven
code language-shell
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": "Dynamics connection",
      "description": "Dynamics connection using key-based authentication",
      "auth": {
          "specName": "Service Principal Key Based Authentication",
          "params": {
              "serviceUri": "{SERVICE_URI}",
              "servicePrincipalId": "{SERVICE_PRINCIPAL_ID}",
              "servicePrincipalKey": "{SERVICE_PRINCIPAL_KEY}"
          }
      },
      "connectionSpec": {
          "id": "38ad80fe-8b06-4938-94f4-d4ee80266b07",
          "version": "1.0"
      }
  }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2
Eigenschap Beschrijving
auth.params.serviceUri De service-URI die aan uw Dynamics -instantie is gekoppeld.
auth.params.servicePrincipalId De client-id van uw Dynamics -account. Deze ID wordt vereist wanneer het gebruiken van de dienst hoofd en op sleutel-gebaseerde authentificatie.
auth.params.servicePrincipalKey De geheime sleutel van de dienst belangrijkste geheim. Deze referentie wordt vereist wanneer het gebruiken van de dienst belangrijkste en op sleutel-gebaseerde authentificatie.
connectionSpec.id De Dynamics connection specification ID: 38ad80fe-8b06-4938-94f4-d4ee80266b07

Reactie

Een succesvolle reactie keert de pas gecreëerde verbinding, met inbegrip van zijn uniek herkenningsteken (id) terug.

accordion
Selecteren om reactievoorbeeld weer te geven
code language-json
{
    "id": "4cb0c374-d3bb-4557-b139-5712880adc55",
    "etag": "\"9e0052a2-0000-0200-0000-5e35tb330000\""
}

Uw gegevenstabellen verkennen

Als u de gegevenstabellen van Dynamics wilt verkennen, vraagt u GET het /connections/{BASE_CONNECTION_ID}/explore -eindpunt aan en geeft u uw basis-verbindings-id op als onderdeel van de queryparameters.

API formaat

GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
Query-parameters
Beschrijving
{BASE_CONNECTION_ID}
De id van de basisverbinding. Gebruik deze id om de inhoud en structuur van uw bron te verkennen.

Verzoek

Met de volgende aanvraag wordt de lijst met beschikbare tabellen en weergaven opgehaald voor een Dynamics -bron met de id van de basisverbinding: dd668808-25da-493f-8782-f3433b976d1e .

Selecteren om aanvraagvoorbeeld weer te geven
code language-shell
curl -X GET \
  'https://platform.adobe.io/data/foundation/flowservice/connections/dd668808-25da-493f-8782-f3433b976d1e/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}' \
  -H 'Content-Type: application/json' \

Reactie

Een geslaagde reactie retourneert de map Dynamics tables and views op het hoofdniveau.

Selecteren om reactievoorbeeld weer te geven
code language-json
[
    {
        "type": "table",
        "name": "systemuserlicenses",
        "path": "systemuserlicenses",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "table",
        "name": "Process Dependency",
        "path": "workflowdependency",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "view",
        "name": "accountView1",
        "path": "accountView1",
        "canPreview": true,
        "canFetchSchema": true
    },
    {
        "type": "view",
        "name": "Inactive_ACC_custom",
        "path": "Inactive_ACC_custom",
        "canPreview": true,
        "canFetchSchema": true
    }
]

De primaire sleutel gebruiken om gegevensexploratie te optimaliseren

NOTE
U kunt niet-lookup attributen slechts gebruiken wanneer het gebruiken van de primaire zeer belangrijke benadering van optimalisering.

U kunt zoekopdrachten optimaliseren door primaryKey op te geven als onderdeel van de queryparameters. U moet de primaire sleutel van de tabel Dynamics opgeven wanneer u primaryKey opneemt als een queryparameter.

API formaat

GET /connections/{BASE_CONNECTION_ID}/explore?preview=true&object={OBJECT}&objectType={OBJECT_TYPE}&previewCount=10&primaryKey={PRIMARY_KEY}
Query-parameters
Beschrijving
{BASE_CONNECTION_ID}
De id van de basisverbinding. Gebruik deze id om de inhoud en structuur van uw bron te verkennen.
preview
Een Booleaanse waarde die gegevensvoorvertoning inschakelt.
{OBJECT}
Het Dynamics -object dat u wilt verkennen.
{OBJECT_TYPE}
Het type object.
previewCount
Een beperking die de geretourneerde voorvertoning beperkt tot slechts een bepaald aantal records.
{PRIMARY_KEY}
De primaire sleutel van de lijst die u voor voorproef terugwint.

Verzoek

Selecteren om aanvraagvoorbeeld weer te geven
code language-shell
curl -X GET \
  'https://platform-stage.adobe.io/data/foundation/flowservice/connections/dd668808-25da-493f-8782-f3433b976d1e/explore?preview=true&object=lead&objectType=table&previewCount=10&primaryKey=leadid' \
  -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' \

De structuur van een tabel controleren

Als u de structuur van een specifieke tabel wilt inspecteren, vraagt u GET /connections/{BASE_CONNECTION_ID}/explore aan en geeft u het pad naar de specifieke tabel op als een queryparameter.

API formaat

GET /connections/{BASE_CONNECTION_ID}/explore?object={TABLE_PATH}&objectType=table
Query-parameter
Beschrijving
{BASE_CONNECTION_ID}
De id van de basisverbinding. Gebruik deze id om de inhoud en structuur van uw bron te verkennen.
{TABLE_PATH}
Het pad naar de tabel die u wilt verkennen.

Verzoek

Met de volgende aanvraag worden de structuur en inhoud van een Dynamics -tabel met pad workflowdependency opgehaald.

Selecteren om aanvraagvoorbeeld weer te geven
code language-shell
curl -X GET \
  'https://platform.adobe.io/data/foundation/flowservice/connections/dd668808-25da-493f-8782-f3433b976d1e/explore?object=workflowdependency&objectType=table' \
  -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' \

Reactie

Een geslaagde reactie retourneert de inhoud van het pad workflowdependency .

Selecteren om reactievoorbeeld weer te geven
code language-json
{
    "format": "flat",
    "schema": {
        "columns": [
            {
                "name": "first_name",
                "type": "string",
                "meta": {
                    "originalType": "String"
                }
            },
            {
                "name": "last_name",
                "type": "string",
                "meta": {
                    "originalType": "String"
                }
            },
            {
                "name": "email",
                "type": "string",
                "meta": {
                    "originalType": "String"
                }
            }
        ]
    }
}

De structuur van een weergave controleren

In Dynamics verwijst een weergave naar de kolommen die moeten worden weergegeven, de breedte van elke kolom, het standaardsysteem waarin een lijst met records wordt gesorteerd en de standaardfilters die worden toegepast om te beperken welke records in de lijst worden weergegeven.

Als u de structuur van een weergave wilt inspecteren, vraagt u GET /connections/{BASE_CONNECTION_ID}/explore aan en geeft u het weergavepad op in de queryparameters. Daarnaast moet u objectType als view opgeven.

API formaat

GET /connections/{BASE_CONNECTION_ID}/explore?object={VIEW_PATH}&objectType=view
Query-parameter
Beschrijving
{BASE_CONNECTION_ID}
De id van de basisverbinding. Gebruik deze id om de inhoud en structuur van uw bron te verkennen.
{VIEW_PATH}
Het pad naar de weergave die u wilt inspecteren.

Verzoek

Met de volgende aanvraag wordt accountView1 opgehaald.

Selecteren om aanvraagvoorbeeld weer te geven
code language-shell
curl -X GET \
  'https://platform.adobe.io/data/foundation/flowservice/connections/dd668808-25da-493f-8782-f3433b976d1e/explore?object=accountView1&objectType=view' \
  -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' \

Reactie

Een geslaagde reactie retourneert de structuur van accountView1 .

Selecteren om reactievoorbeeld weer te geven
code language-json
{
    "format": "flat",
    "schema": {
        "columns": [
            {
                "name": "name",
                "type": "string",
                "meta": {
                    "originalType": "string"
                },
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "fetchxml",
                "type": "string",
                "meta": {
                    "originalType": "string"
                },
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "querytype",
                "type": "integer",
                "meta": {
                    "originalType": "int"
                },
                "xdm": {
                    "type": "integer",
                    "minimum": -2147483648,
                    "maximum": 2147483647
                }
            },
            {
                "name": "userqueryid",
                "type": "string",
                "meta": {
                    "originalType": "guid"
                },
                "xdm": {
                    "type": "string"
                }
            }
        ]
    }
}

Weergave entiteitstype voorvertonen

Als u een voorvertoning van de inhoud van een weergave wilt weergeven, vraagt u GET om /connections/{BASE_CONNECTION_ID}/explore en neemt u het weergavepad en preview=true op in de queryparameters.

API formaat

GET /connections/{BASE_CONNECTION_ID}/explore?object={VIEW_PATH}&preview=true&objectType=view
Query-parameter
Beschrijving
{BASE_CONNECTION_ID}
De id van de basisverbinding. Gebruik deze id om de inhoud en structuur van uw bron te verkennen.
{VIEW_PATH}
Het pad naar de weergave die u wilt inspecteren.

Verzoek

In de volgende aanvraag wordt een voorvertoning van de inhoud van accountView1 weergegeven.

Selecteren om aanvraagvoorbeeld weer te geven
code language-shell
curl -X GET \
  'https://platform.adobe.io/data/foundation/flowservice/connections/dd668808-25da-493f-8782-f3433b976d1e/explore?object=accountView1&preview=true&objectType=view' \
  -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' \

Reactie

Een succesvol antwoord retourneert de inhoud van accountView1 .

Selecteren om reactievoorbeeld weer te geven
code language-json
{
    "format": "flat",
    "schema": {
        "columns": [
            {
                "name": "emailaddress1",
                "type": "string",
                "meta": {
                    "originalType": "string"
                },
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "contactid",
                "type": "string",
                "meta": {
                    "originalType": "guid"
                },
                "xdm": {
                    "type": "string"
                }
            },
            {
                "name": "fullname",
                "type": "string",
                "meta": {
                    "originalType": "string"
                },
                "xdm": {
                    "type": "string"
                }
            }
        ]
    },
    "data": [
        {
            "contactid": "396e19de-0852-ec11-8c62-00224808a1df",
            "fullname": "Tim Barr",
            "emailaddress1": "barrtim@googlemedia.com"
        }
    ]
}

Een bronverbinding maken met de ingesloten weergave

Als u een bronverbinding wilt maken en een weergave wilt insluiten, vraagt u een POST-aanvraag naar het eindpunt van /sourceConnections , geeft u de tabelnaam op en geeft u entityType as view op in de hoofdtekst van de aanvraag.

API formaat

POST /sourceConnections

Verzoek

Met de volgende aanvraag wordt een Dynamics bronverbinding gemaakt en worden weergaven ingesloten.

Selecteren om aanvraagvoorbeeld weer te geven
code language-shell
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": "Dynamics Source Connection",
      "description": "Dynamics Source Connection",
      "baseConnectionId": "dd668808-25da-493f-8782-f3433b976d1e",
      "data": {
          "format": "tabular",
          "schema": null,
          "properties": null
      },
      "params": {
          "tableName": "Contacts with name TIM",
          "entityType": "view"
      },
      "connectionSpec": {
          "id": "38ad80fe-8b06-4938-94f4-d4ee80266b07",
          "version": "1.0"
      }
  }'

Reactie

Een geslaagde reactie retourneert de zojuist gegenereerde bron-verbindings-id en de bijbehorende tag.

Selecteren om reactievoorbeeld weer te geven
code language-json
{
    "id": "e566bab3-1b58-428c-b751-86b8cc79a3b4",
    "etag": "\"82009592-0000-0200-0000-678121030000\""
}

De primaire sleutel gebruiken om uw gegevensstroom te optimaliseren

U kunt de gegevensstroom van Dynamics ook optimaliseren door de primaire sleutel als deel van uw parameters van het verzoeklichaam te specificeren.

API formaat

POST /sourceConnections

Verzoek

Met de volgende aanvraag wordt een Dynamics bronverbinding gemaakt terwijl de primaire sleutel wordt opgegeven als contactid .

Selecteren om aanvraagvoorbeeld weer te geven
code language-shell
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": "Dynamics Source Connection",
      "description": "Dynamics Source Connection",
      "baseConnectionId": "dd668808-25da-493f-8782-f3433b976d1e",
      "data": {
          "format": "tabular"
      },
      "params": {
          "tableName": "contact",
          "primaryKey": "contactid"
      },
      "connectionSpec": {
          "id": "38ad80fe-8b06-4938-94f4-d4ee80266b07",
          "version": "1.0"
      }
  }'
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2
Eigenschap Beschrijving
baseConnectionId De id van de basisverbinding.
data.format De indeling van de gegevens.
params.tableName De naam van de tabel in Dynamics .
params.primaryKey De primaire sleutel van de lijst die vragen zal optimaliseren.
connectionSpec.id De verbindingsspecificatie-id die overeenkomt met de bron Dynamics .

Reactie

Een geslaagde reactie retourneert de zojuist gegenereerde bron-verbindings-id en de bijbehorende tag.

Selecteren om reactievoorbeeld weer te geven
code language-json
{
    "id": "e566bab3-1b58-428c-b751-86b8cc79a3b4",
    "etag": "\"82009592-0000-0200-0000-678121030000\""
}

Volgende stappen

Aan de hand van deze zelfstudie hebt u een Microsoft Dynamics basisverbinding gemaakt met de Flow Service API. U kunt deze basis verbindings-id in de volgende zelfstudies gebruiken:

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