Lesen von Beispiel-API-Aufrufen
In diesem Tutorial wird anhand von Beispielen für API-Aufrufe die korrekte Formatierung von Anfragen aufgezeigt. Dazu gehören Pfade, erforderliche Kopfzeilen und ordnungsgemäß formatierte Anfrage-Payloads. Außerdem wird ein Beispiel für eine von der API im JSON-Format zurückgegebene Antwort bereitgestellt. Informationen zu den Konventionen, die in der Dokumentation für Beispiel-API-Aufrufe verwendet werden, finden Sie im Abschnitt zum Lesen von Beispiel-API-Aufrufen im Handbuch zur Fehlerbehebung für Experience Platform
Sammeln von Werten für erforderliche Kopfzeilen
Um Experience Platform-APIs aufzurufen, müssen Sie zunächst das Authentifizierungs-Tutorial abschließen. Durch Abschluss des Authentifizierungs-Tutorials werden die Werte für die einzelnen erforderlichen Kopfzeilen in allen Experience Experience Platform-API-Aufrufen bereitgestellt, wie unten dargestellt:
Authorization: Bearer {ACCESS_TOKEN}x-api-key: {API_KEY}x-gw-ims-org-id: {ORG_ID}
Alle Ressourcen in Experience Platform, einschließlich der Ressourcen, die zu Flow Service gehören, werden in bestimmten virtuellen Sandboxes isoliert. Bei allen Anfragen an Experience Platform-APIs ist eine Kopfzeile erforderlich, die den Namen der Sandbox angibt, in der der Vorgang ausgeführt werden soll:
x-sandbox-name: {SANDBOX_NAME}
Bei allen Anfragen, die eine Payload enthalten (POST, PUT, PATCH), ist eine zusätzliche Medientyp-Kopfzeile erforderlich:
Content-Type: application/json
Erkunden von Datentabellen
Mithilfe der Verbindungs-ID für Ihre Datenbank können Sie Ihre Datentabellen untersuchen, indem Sie GET-Anfragen ausführen. Verwenden Sie den folgenden Aufruf, um den Pfad der Tabelle zu finden, die Sie untersuchen oder in Experience Platform aufnehmen möchten.
API-Format
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=root
| Parameter | Beschreibung |
|---|---|
{BASE_CONNECTION_ID} | Die Verbindungs-ID Ihrer Datenbankquelle. |
Anfrage
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/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}'
Antwort
Eine erfolgreiche Antwort gibt ein Array von Tabellen aus Ihrer Datenbank zurück. Suchen Sie die Tabelle, die Sie in Experience Platform importieren möchten, und notieren Sie sich ihre path Eigenschaft, da Sie sie im nächsten Schritt bereitstellen müssen, um ihre Struktur zu überprüfen.
[
{
"type": "table",
"name": "test1.Mytable",
"path": "test1.Mytable",
"canPreview": true,
"canFetchSchema": true
},
{
"type": "table",
"name": "test1.austin_demo",
"path": "test1.austin_demo",
"canPreview": true,
"canFetchSchema": true
}
]
Überprüfen der Tabellenstruktur
Um die Tabellenstruktur in Ihrer Datenbank zu überprüfen, führen Sie eine GET-Anfrage aus und geben Sie dabei den Pfad einer Tabelle als Abfrageparameter an.
API-Format
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=table&object={TABLE_PATH}
| Parameter | Beschreibung |
|---|---|
{BASE_CONNECTION_ID} | Die ID einer Datenbankverbindung. |
{TABLE_PATH} | Der Pfad einer Tabelle. |
Anfrage
curl -X GET \
'https://platform.adobe.io/data/foundation/flowservice/connections/6990abad-977d-41b9-a85d-17ea8cf1c0e4/explore?objectType=table&object=test1.Mytable' \
-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}'
Antwort
Eine erfolgreiche Antwort gibt die Struktur der angegebenen Tabelle zurück. Details zu den einzelnen Spalten der Tabelle befinden sich in Elementen des columns-Arrays.
{
"format": "flat",
"schema": {
"columns": [
{
"name": "TestID",
"type": "string",
"xdm": {
"type": "string"
}
},
{
"name": "Name",
"type": "string",
"xdm": {
"type": "string"
}
}
]
}
}
Nächste Schritte
In diesem Tutorial haben Sie Ihre Datenbank erkundet, den Pfad der Tabelle gefunden, die Sie in Experience Platform aufnehmen möchten, und Informationen über ihre Struktur erhalten. Sie können diese Informationen im nächsten Tutorial verwenden um Daten aus Ihrer Datenbank zu erfassen und in Experience Platform zu.
Experience Platform
