Een CRM-systeem verkennen met de API Flow Service
Gemaakt voor:
- Ontwikkelaar
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.
Deze zelfstudie gebruikt de Flow Service API om CRM-systemen 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 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.
De volgende secties bevatten aanvullende informatie die u moet weten om verbinding te kunnen maken met een CRM-systeem met de Flow Service API.
Verbindings-id maken
Als u uw CRM-systeem wilt verkennen met API's van Platform , moet u over een geldige verbinding-id beschikken. Als u nog geen verbinding hebt voor het CRM-systeem waarmee u wilt werken, kunt u een verbinding maken via de volgende zelfstudies:
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 vraagin de Experience Platform het oplossen van problemengids te lezen.
Waarden verzamelen voor vereiste koppen
Om vraag aan 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 API-aanroepen van Experience Platform , zoals hieronder wordt getoond:
Authorization: Bearer {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 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 nuttige lading (POST, PUT, PATCH) bevatten vereisen een extra media type kopbal:
Content-Type: application/json
Uw gegevenstabellen verkennen
Gebruikend verbindingsidentiteitskaart voor uw systeem van CRM, kunt u uw gegevenslijsten onderzoeken door verzoeken van de GET uit te voeren. Gebruik de volgende aanroep om het pad te zoeken van de tabel die u wilt inspecteren of waarin u wilt opnemen Platform.
API formaat
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
{BASE_CONNECTION_ID}Verzoek
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/{BASE_CONNECTION_ID}/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 CRM. Zoek de tabel die u wilt opnemen in 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": "Solution Component Summary",
"path": "msdyn_solutioncomponentsummary",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Quote Invoicing Product",
"path": "msdyn_quoteinvoicingproduct",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "Opportunity Relationship",
"path": "customeropportunityrole",
"canPreview": true,
"canFetchSchema": true
}
]
De structuur van een tabel Inspect
Om de structuur van een lijst van uw systeem van CRM te inspecteren, voer een verzoek van de 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}
{BASE_CONNECTION_ID}{TABLE_PATH}Verzoek
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}' \
-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": "first_name",
"type": "string",
"meta": {
"originalType": "String"
}
},
{
"name": "last_name",
"type": "string",
"meta": {
"originalType": "String"
}
},
{
"name": "email",
"type": "string",
"meta": {
"originalType": "String"
}
}
]
}
}
Volgende stappen
Aan de hand van deze zelfstudie hebt u uw CRM-systeem verkend, het pad gevonden van de tabel die u wilt doorgeven aan Platform en hebt u informatie verkregen over de structuur ervan. U kunt deze informatie in het volgende leerprogramma gebruiken gegevens van uw systeem van CRM verzamelen en het brengen in Platform.