[Beta]{class="badge informative"}
Een bronverbinding en gegevensstroom maken voor Oracle NetSuite Entities met de Flow Service API
Lees het volgende leerprogramma leren hoe te om contacten en klantengegevens van uw Oracle NetSuite Activities Entities rekening aan Adobe Experience Platform te brengen gebruikend Flow Service API.
Aan de slag
Deze handleiding vereist een goed begrip van de volgende onderdelen van het 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 het Platform.
- Sandboxes: Experience Platform verstrekt virtuele zandbakken die één enkele instantie van het Platform in afzonderlijke virtuele milieu's verdelen helpen digitale ervaringstoepassingen ontwikkelen en ontwikkelen.
In de volgende secties vindt u aanvullende informatie die u moet weten voordat u verbinding kunt maken met Oracle NetSuite Entities via de Flow Service API.
Verificatie
Lees het Oracle NetSuite overzichtvoor informatie over hoe te om uw authentificatiegeloofsbrieven terug te winnen.
Platform-API's gebruiken
Voor informatie over hoe te om vraag aan Platform APIs met succes te maken, zie de gids op begonnen wordt met Platform APIs.
Verbinding maken Oracle NetSuite Entities met platform met behulp van de Flow Service API
In het volgende voorbeeld worden de stappen beschreven die u moet uitvoeren om de Oracle NetSuite Entities -bron te verifiëren, een bronverbinding te maken en een gegevensstroom te maken om uw klant en contactgegevens naar het Experience Platform te brengen.
Een basisverbinding maken base-connection
Een basisverbinding behoudt informatie tussen uw bron en Platform, met inbegrip van de de authentificatiegeloofsbrieven van uw bron, de huidige staat 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 naar het /connections -eindpunt en geeft u de Oracle NetSuite Entities -verificatiegegevens op als onderdeel van de aanvraaginstantie.
API formaat
POST /connections
Verzoek
Met de volgende aanvraag wordt een basisverbinding voor Oracle NetSuite Entities gemaakt:
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": "Oracle NetSuite Entities base connection",
"description": "Authenticated base connection for Oracle NetSuite Entities",
"connectionSpec": {
"id": "fdf850b4-5a8d-4a5a-9ce8-4caef9abb2a8",
"version": "1.0"
},
"auth": {
"specName": "OAuth2 Client Credential",
"params": {
"clientId": "{CLIENT_ID}",
"clientSecret": "{CLIENT_SECRET}"
"accessTokenUrl": "{ACCESS_TOKEN_URL}",
"accessToken": "{ACCESS_TOKEN_URL}"
}
}
}'
namedescriptionconnectionSpec.idauth.specNameauth.params.clientId7fce.....b42f .auth.params.clientSecret5c98.....1b46 .auth.params.accessTokenUrlhttps://{ACCOUNT_ID}.suitetalk.api.netsuite.com/services/rest/auth/oauth2/v1/token waar u ACCOUNT_ID vervangt door uw account-id van NetSuite .auth.params.accessTokeneyJr......f4V0 .Reactie
Een succesvolle reactie keert de pas gecreëerde basisverbinding, met inbegrip van zijn unieke verbindings herkenningsteken (id) terug. Deze id is vereist om de bestandsstructuur en inhoud van uw bron in de volgende stap te verkennen.
{
"id": "60c81023-99b4-4aae-9c31-472397576dd2",
"etag": "\"fa003785-0000-0200-0000-6555c5310000\""
}
Ontdek uw bron explore
Zodra u uw identiteitskaart van de basisverbinding hebt, kunt u de inhoud en de structuur van uw brongegevens nu onderzoeken door een verzoek van de GET aan het /connections eindpunt uit te voeren terwijl het verstrekken van uw identiteitskaart van de basisverbinding als vraagparameter.
API formaat
GET /connections/{BASE_CONNECTION_ID}/explore?objectType=rest&object={OBJECT}&fileType={FILE_TYPE}&preview={PREVIEW}&sourceParams={SOURCE_PARAMS}
Verzoek
Wanneer het uitvoeren van GET verzoeken om de het dossierstructuur en inhoud van uw bron te onderzoeken, moet u de vraagparameters omvatten die in de lijst hieronder vermeld zijn:
{BASE_CONNECTION_ID}objectType=restrest .{OBJECT}json zijn.fileType=jsonjson het enige ondersteunde bestandstype.{PREVIEW}{SOURCE_PARAMS}Bepaalt parameters voor het brondossier u aan Platform wilt brengen. Als u het geaccepteerde indelingstype voor {SOURCE_PARAMS} wilt ophalen, moet u de gehele tekenreeks coderen in base64.
Oracle NetSuite Entities biedt ondersteuning voor het ophalen van zowel klant- als contactgegevens. Afhankelijk van het objecttype dat u gebruikt, geeft u een van de volgende waarden door:
customer: Haal specifieke klantgegevens op, zoals klantnamen, adressen en toetsidentificatoren.contact: ontvang contactnamen, e-mails, telefoonnummers en eventuele aangepaste contactvelden die aan klanten zijn gekoppeld.
Voor Oracle NetSuite Entities wordt voor het ophalen van contactgegevens de waarde voor {SOURCE_PARAMS} doorgegeven als {"object_type":"customer"} . Wanneer gecodeerd in base64, komt deze overeen met eyAib2JqZWN0X3R5cGUiOiAiY3VzdG9tZXIifQ%3D%3D zoals hieronder weergegeven.
| code language-shell |
|---|
|
Voor Oracle NetSuite Entities wordt voor het ophalen van contactgegevens de waarde voor {SOURCE_PARAMS} doorgegeven als {"object_type":"contact"} . Wanneer gecodeerd in base64, komt deze overeen met eyAib2JqZWN0X3R5cGUiOiAiY29udGFjdCJ9 zoals hieronder weergegeven.
| code language-shell |
|---|
|
Reactie
En afhankelijk van welk objecttype u de ontvangen reactie leveraging is de volgende tabel:
Een geslaagde reactie retourneert een structuur zoals hieronder.
| accordion | ||
|---|---|---|
| Selecteren om de JSON-payload weer te geven | ||
|
Een geslaagde reactie retourneert een structuur zoals hieronder.
| accordion | ||
|---|---|---|
| Selecteren om de JSON-payload weer te geven | ||
|
Een bronverbinding maken source-connection
U kunt een bronverbinding maken door een aanvraag voor een POST in te dienen bij het eindpunt /sourceConnections van de Flow Service API. Een bronverbinding bestaat uit een verbinding-id, een pad naar het brongegevensbestand en een verbindingsspecificatie-id.
API formaat
POST /sourceConnections
Verzoek
Met de volgende aanvraag wordt een bronverbinding gemaakt voor Oracle NetSuite Entities :
Bij het ophalen van klantgegevens moet de waarde van de eigenschap object_type customer zijn.
| code language-shell |
|---|
|
Bij het ophalen van contactgegevens moet de waarde van de eigenschap object_type contact zijn.
| code language-shell |
|---|
|
namedescriptionbaseConnectionIdconnectionSpec.iddata.formatjson .object_typeOracle NetSuite Entities ondersteunt zowel ophalen door de klant als opvragen door contact. Afhankelijk van welke entiteit u wilt, geeft u een van de volgende waarden door:
customer: Haal specifieke klantgegevens op, zoals klantnamen, adressen en toetsidentificatoren.contact: ontvang contactnamen, e-mails, telefoonnummers en eventuele aangepaste contactvelden die aan klanten zijn gekoppeld.
Reactie
Een succesvolle reactie keert het unieke herkenningsteken (id) van de pas gecreëerde bronverbinding terug. Deze id is in een latere stap vereist om een gegevensstroom te maken.
{
"id": "574c049f-29fc-411f-be0d-f80002025f51",
"etag": "\"0704acb3-0000-0200-0000-6555c5470000\""
}
Een doel-XDM-schema maken target-schema
Om de brongegevens in Platform te gebruiken, moet een doelschema worden gecreeerd om de brongegevens volgens uw behoeften te structureren. Het doelschema wordt dan gebruikt om een dataset van het Platform tot stand te brengen waarin de brongegevens bevat zijn.
Een doelXDM schema kan worden gecreeerd door een verzoek van de POST aan de Registratie API van het Schemauit te voeren.
Voor gedetailleerde stappen op hoe te om een doelXDM schema tot stand te brengen, zie het leerprogramma op creërend een schema gebruikend API.
Een doelgegevensset maken target-dataset
Een doeldataset kan worden gecreeerd door een verzoek van de POST aan de Dienst API van de Catalogus uit te voeren, verstrekkend identiteitskaart van het doelschema binnen de nuttige lading.
Voor gedetailleerde stappen op hoe te om een doeldataset tot stand te brengen, zie het leerprogramma op het creëren van een dataset gebruikend API.
Een doelverbinding maken target-connection
Een doelverbinding vertegenwoordigt de verbinding met de bestemming waar de ingesloten gegevens moeten worden opgeslagen. Om een doelverbinding tot stand te brengen, moet u vaste identiteitskaart verstrekken van de verbindingsspecificatie die aan het gegevens meer beantwoordt. Deze id is: c604ff05-7f1a-43c0-8e18-33bf874cb11c .
U hebt nu de unieke herkenningstekens een doelschema een doeldataset en identiteitskaart van de verbindingsspecificatie aan het gegevensmeer. Met behulp van deze id's kunt u een doelverbinding maken met de Flow Service API om de gegevensset op te geven die de binnenkomende brongegevens zal bevatten.
API formaat
POST /targetConnections
Verzoek
Met de volgende aanvraag wordt een doelverbinding voor Oracle NetSuite Entities gemaakt:
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/targetConnections' \
-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": "Oracle NetSuite Entities Target Connection Generic Rest",
"description": " Oracle NetSuite Entities Connection Generic Rest",
"connectionSpec": {
"id": "c604ff05-7f1a-43c0-8e18-33bf874cb11c",
"version": "1.0"
},
"data": {
"format": "parquet_xdm",
"schema": {
"id": "https://ns.adobe.com/{TENANT_ID}/schemas/325fd5394ba421246b05c0a3c2cd5efeec2131058a63d473",
"version": "1.2"
}
},
"params": {
"dataSetId": "65004470082ac828d2c3d6a0"
}
}'
namedescriptionconnectionSpec.id6b137bf6-d2a0-48c8-914b-d50f4942eb85 .data.formatparams.dataSetIdReactie
Een succesvolle reactie keert het unieke herkenningsteken van de nieuwe doelverbinding (id) terug. Deze id is vereist in latere stappen.
{
"id": "382fc614-3c5b-46b9-a971-786fb0ae6c5d",
"etag": "\"e0016100-0000-0200-0000-655707a40000\""
}
Een toewijzing maken mapping
Opdat de brongegevens in een doeldataset moeten worden opgenomen, moet het eerst aan het doelschema worden in kaart gebracht dat de doeldataset zich aan houdt. Dit wordt bereikt door een verzoek van de POST aan Data Prep APImet gegevenstoewijzingen uit te voeren die binnen de verzoeklading worden bepaald.
API formaat
POST /conversion/mappingSets
Verzoek
Met de volgende aanvraag wordt een toewijzing gemaakt voor DNL NetSuite Entities
curl -X POST \
'https://platform.adobe.io/data/foundation/conversion/mappingSets' \
-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 '{
"outputSchema": {
"schemaRef": {
"id": "https://ns.adobe.com/{TENANT_ID}/schemas/b156e6f818f923e048199173c45e55e20fd2487f5eb03d22",
"contentType": "application/vnd.adobe.xed-full+json;version=1"
}
},
"mappings": [
{
"sourceType": "ATTRIBUTE",
"source": "items.id",
"destination": "_extconndev.NS_ID"
},
{
"sourceType": "ATTRIBUTE",
"source": "items.entitytitle",
"destination": "_extconndev.NS_entity_title"
},
{
"sourceType": "ATTRIBUTE",
"source": "items.datecreated",
"destination": "_extconndev.NS_datecreated"
},
{
"sourceType": "ATTRIBUTE",
"destination": "_extconndev.NS_email",
"source": "items.email"
},
{
"sourceType": "ATTRIBUTE",
"source": "items.lastmodifieddate",
"destination": "_extconndev.NS_lastmodified"
}
]
}'
outputSchema.schemaRef.idmappings.sourceTypemappings.sourcemappings.destinationReactie
Een succesvolle reactie keert details van de pas gecreëerde afbeelding met inbegrip van zijn uniek herkenningsteken (id) terug. Deze waarde is in een latere stap vereist om een gegevensstroom te maken.
{
"id": "ddf0592bcc9d4ac391803f15f2429f87",
"version": 0,
"createdDate": 1597784069368,
"modifiedDate": 1597784069368,
"createdBy": "{CREATED_BY}",
"modifiedBy": "{MODIFIED_BY}"
}
Een flow maken flow
De laatste stap op weg naar het verzenden van gegevens van Oracle NetSuite Entities naar Platform is het maken van een gegevensstroom. Momenteel zijn de volgende vereiste waarden voorbereid:
Een dataflow is verantwoordelijk voor het plannen en verzamelen van gegevens uit een bron. U kunt een gegevensstroom tot stand brengen door een verzoek van de POST uit te voeren terwijl het verstrekken van de eerder vermelde waarden binnen de lading.
API formaat
POST /flows
Verzoek
curl -X POST \
'https://platform.adobe.io/data/foundation/flowservice/flows' \
-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": "Oracle NetSuite Entities connector Flow Generic Rest",
"description": "Oracle NetSuite Entities connector Description Flow Generic Rest",
"flowSpec": {
"id": "6499120c-0b15-42dc-936e-847ea3c24d72",
"version": "1.0"
},
"sourceConnectionIds": [
"d8827440-339f-428d-bf38-5e2ab1f0f7bb"
],
"targetConnectionIds": [
"e349a15e-c639-4047-8b2a-154aa7a857d7"
],
"transformations": [
{
"name": "Mapping",
"params": {
"mappingId": "10787532e0994eb686e76bdab69a9e88",
"mappingVersion": 0
}
}
],
"scheduleParams": {
"startTime": 1700202649,
"frequency": "once"
}
}'
namedescriptionflowSpec.id6499120c-0b15-42dc-936e-847ea3c24d72 .flowSpec.version1.0 .sourceConnectionIdstargetConnectionIdstransformationstransformations.nametransformations.params.mappingIdtransformations.params.mappingVersion0 .scheduleParams.startTimescheduleParams.frequencyscheduleParams.intervalReactie
Een succesvolle reactie keert identiteitskaart (id) van nieuw gecreeerd dataflow terug. Met deze id kunt u uw gegevensstroom controleren, bijwerken of verwijderen.
{
"id": "84c64142-1741-4b0b-95a9-65644eba0cf6",
"etag": "\"3901770b-0000-0200-0000-655708970000\""
}
Bijlage
In de volgende sectie vindt u informatie over de stappen die u kunt uitvoeren om uw gegevensstroom te controleren, bij te werken en te verwijderen.
Uw gegevensstroom controleren
Zodra uw gegevensstroom is gecreeerd, kunt u de gegevens controleren die door het worden opgenomen om informatie over stroomlooppas, voltooiingsstatus, en fouten te zien. Voor volledige API voorbeelden, lees de gids op controlerend uw brongegevens gebruikend API.
Uw gegevensstroom bijwerken
Werk de details van uw gegevensstroom bij, zoals zijn naam en beschrijving, evenals zijn looppas programma en bijbehorende kaartreeksen door een PATCH verzoek aan het /flows eindpunt van Flow Service API te richten, terwijl het verstrekken van identiteitskaart van uw gegevensstroom. Wanneer u een PATCH-verzoek indient, moet u de unieke etag gegevens van uw gegevensstroom opgeven in de If-Match -header. Voor volledige API voorbeelden, lees de gids bij het bijwerken bronnen dataflows gebruikend API.
Uw account bijwerken
Werk de naam, beschrijving en gegevens van uw bronaccount bij door een PATCH-aanvraag uit te voeren naar de Flow Service API en uw basis-verbindings-id op te geven als een queryparameter. Wanneer u een PATCH-aanvraag indient, moet u de unieke etag van uw bronaccount opgeven in de If-Match -header. Voor volledige API voorbeelden, lees de gids bij het bijwerken van uw bronrekening gebruikend API.
Uw gegevensstroom verwijderen
Verwijder de gegevensstroom door een DELETE-aanvraag uit te voeren naar de Flow Service API en de id op te geven van de gegevensstroom die u wilt verwijderen als onderdeel van de queryparameter. Voor volledige API voorbeelden, lees de gids op schrappend uw dataflows gebruikend API.
Uw account verwijderen
Verwijder uw account door een DELETE-aanvraag uit te voeren naar de Flow Service API terwijl u de basis verbinding-id opgeeft van het account dat u wilt verwijderen. Voor volledige API voorbeelden, lees de gids bij het schrappen van uw bronrekening gebruikend API.