Configurare le specifiche di origine per le origini self-service (SDK batch)
Le specifiche dell'origine contengono informazioni specifiche per un'origine, inclusi gli attributi relativi alla categoria, allo stato beta e all'icona del catalogo di un'origine. Contengono anche informazioni utili come parametri URL, contenuto, intestazione e pianificazione. Le specifiche di origine descrivono anche lo schema dei parametri necessari per creare una connessione di origine da una connessione di base. Lo schema è necessario per creare una connessione di origine.
Consulta la appendice ad esempio una specifica di origine completamente popolata.
"sourceSpec": {
"attributes": {
"uiAttributes": {
"isSource": true,
"isPreview": true,
"isBeta": true,
"category": {
"key": "protocols"
},
"icon": {
"key": "genericRestIcon"
},
"description": {
"key": "genericRestDescription"
},
"label": {
"key": "genericRestLabel"
}
},
"spec": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"description": "Defines static and user input parameters to fetch resource values.",
"properties": {
"urlParams": {
"type": "object",
"properties": {
"host": {
"type": "string",
"description": "Enter resource url host path.",
"example": "https://{domain}.api.mailchimp.com"
},
"path": {
"type": "string",
"description": "Enter resource path",
"example": "/3.0/reports/campaignId/email-activity"
},
"method": {
"type": "string",
"description": "HTTP method type.",
"enum": [
"GET",
"POST"
]
},
"queryParams": {
"type": "object",
"description": "The query parameters in json format",
}
},
"required": [
"host",
"path",
"method"
]
},
"headerParams": {
"type": "object",
"description": "The header parameters in json format",
},
"contentPath": {
"type": "object",
"description": "The parameters required for main collection content.",
"properties": {
"path": {
"description": "The path to the main content.",
"type": "string",
"example": "$.emails"
},
"skipAttributes": {
"type": "array",
"description": "The list of attributes that needs to be skipped while fattening the array.",
"example": "[total_items]",
"items": {
"type": "string"
}
},
"keepAttributes": {
"type": "array",
"description": "The list of attributes that needs to be kept while fattening the array.",
"example": "[total_items]",
"items": {
"type": "string"
}
},
"overrideWrapperAttribute": {
"type": "string",
"description": "The new name to be used for the root content path node.",
"example": "email"
}
},
"required": [
"path"
]
},
"explodeEntityPath": {
"type": "object",
"description": "The parameters required for the sub-array content.",
"properties": {
"path": {
"description": "The path to the sub-array content.",
"type": "string",
"example": "$.email.activity"
},
"skipAttributes": {
"type": "array",
"description": "The list of attributes that needs to be skipped while fattening sub-array.",
"example": "[total_items]",
"items": {
"type": "string"
}
},
"keepAttributes": {
"type": "array",
"description": "The list of attributes that needs to be kept while fattening the sub-array.",
"example": "[total_items]",
"items": {
"type": "string"
}
},
"overrideWrapperAttribute": {
"type": "string",
"description": "The new name to be used for the root content path node.",
"example": "activity"
}
},
"required": [
"path"
]
},
"paginationParams": {
"type": "object",
"description": "The parameters required to fetch data using pagination.",
"properties": {
"type": {
"description": "The pagination fetch type.",
"type": "string",
"enum": [
"OFFSET",
"POINTER"
]
},
"limitName": {
"type": "string",
"description": "The limit property name",
"example": "limit or count"
},
"limitValue": {
"type": "integer",
"description": "The number of records to fetch per page.",
"example": "limit=10 or count=10"
},
"offsetName": {
"type": "string",
"description": "The offset property name",
"example": "offset"
},
"pointerPath": {
"type": "string",
"description": "The path to pointer property",
"example": "$.paging.next"
}
},
"required": [
"type",
"limitName",
"limitValue"
]
},
"scheduleParams": {
"type": "object",
"description": "The parameters required to fetch data for batch schedule.",
"properties": {
"scheduleStartParamName": {
"type": "string",
"description": "The order property name to get the order by date."
},
"scheduleEndParamName": {
"type": "string",
"description": "The order property name to get the order by date."
},
"scheduleStartParamFormat": {
"type": "string",
"description": "The order property name to get the order by date.",
"example": "yyyy-MM-ddTHH:mm:ssZ"
},
"scheduleEndParamFormat": {
"type": "string",
"description": "The order property name to get the order by date.",
"example": "yyyy-MM-ddTHH:mm:ssZ"
}
},
"required": [
"scheduleStartParamName",
"scheduleEndParamName"
]
}
},
"required": [
"urlParams",
"contentPath",
"paginationParams",
"scheduleParams"
]
}
},
}
Proprietà
Descrizione
Esempio
sourceSpec.attributes
Contiene informazioni sull’origine specifiche per l’interfaccia utente o l’API.
Definisce i parametri di query supportati che possono essere utilizzati per aggiungere l’URL di origine quando si effettua una richiesta di recupero dei dati. Nota: qualsiasi valore di parametro fornito dall’utente deve essere formattato come segnaposto. Ad esempio: ${USER_PARAMETER}.
"queryParams" : {"key" : "value", "key1" : "value1"} verrà aggiunto all’URL di origine come: /?key=value&key1=value1
Questo attributo può essere configurato per inviare il corpo HTTP tramite una richiesta POST.
sourceSpec.attributes.spec.properties.contentPath
Definisce il nodo che contiene l’elenco degli elementi da acquisire in Platform. Questo attributo deve seguire una sintassi di percorso JSON valida e deve puntare a un array specifico.
Visualizza sezione risorse aggiuntive per un esempio della risorsa contenuta in un percorso di contenuto.
Questa proprietà ti consente di identificare elementi specifici dalla risorsa identificata nel percorso del contenuto che devono essere esclusi dall’acquisizione.
Questa proprietà ti consente di identificare elementi specifici dalla risorsa identificata nel percorso dell’entità che devono essere esclusi dall’acquisizione.
Definisce i parametri o i campi da fornire per ottenere un collegamento alla pagina successiva dalla risposta della pagina corrente dell'utente o durante la creazione di un URL della pagina successiva.
Visualizza il tipo di impaginazione supportato per l'origine.
OFFSET: questo tipo di impaginazione ti consente di analizzare i risultati specificando un indice da cui avviare la matrice risultante e un limite sul numero di risultati restituiti.
POINTER: questo tipo di impaginazione ti consente di utilizzare una pointer variabile per puntare a un particolare elemento che deve essere inviato con una richiesta. L'impaginazione del tipo di puntatore richiede il percorso nel payload che punta alla pagina successiva.
CONTINUATION_TOKEN: questo tipo di impaginazione ti consente di aggiungere alla query o ai parametri di intestazione un token di continuazione per recuperare i dati restituiti rimanenti dall’origine che non sono stati inizialmente restituiti a causa di un massimo predeterminato.
PAGE: questo tipo di impaginazione ti consente di aggiungere al parametro di query un parametro di paging per scorrere i dati restituiti per pagina, a partire dalla pagina zero.
NONE: questo tipo di impaginazione può essere utilizzato per origini che non supportano nessuno dei tipi di impaginazione disponibili. Tipo di impaginazione NONE restituisce tutti i dati di risposta dopo una richiesta.
Nome dell'attributo del puntatore. Questo richiede il percorso json dell’attributo che punterà alla pagina successiva. Questa opzione è necessaria se il tipo di paginazione è impostato su pointer.
Contiene parametri che definiscono i formati di pianificazione supportati per l'origine. I parametri di pianificazione includono startTime e endTime, entrambi che consentono di impostare intervalli di tempo specifici per le esecuzioni batch, in modo da garantire che i record recuperati in una precedente esecuzione batch non vengano recuperati nuovamente.
Definisce il formato supportato per scheduleEndParamName.
yyyy-MM-ddTHH:mm:ssZ
sourceSpec.spec.properties
Definisce i parametri forniti dall'utente per recuperare i valori delle risorse.
Consulta la risorse aggiuntive ad esempio, parametri immessi dall'utente per spec.properties.
Risorse aggiuntive
Le sezioni seguenti forniscono informazioni sulle configurazioni aggiuntive che è possibile apportare al sourceSpec, inclusi la pianificazione avanzata e gli schemi personalizzati.
Esempio di percorso del contenuto
Di seguito è riportato un esempio del contenuto di contentPath proprietà in una MailChimp Members specifica di connessione.
Di seguito è riportato un esempio di spec.properties utilizzando un MailChimp Members specifica di connessione.
In questo esempio, listId viene fornito come parte di urlParams.path. Se è necessario recuperare listId da un cliente, devi anche definirlo come parte di spec.properties.
"urlParams": {
"path": "/3.0/lists/${listId}/members",
"method": "GET"
}
"spec": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"description": "Define user input parameters to fetch resource values.",
"properties": {
"listId": {
"type": "string",
"description": "listId for which members need to fetch."
}
}
}
Esempio di specifica di origine
Di seguito è riportata una specifica di origine completata utilizzando MailChimp Members:
Configurare diversi tipi di impaginazione per l’origine
Di seguito sono riportati alcuni esempi di altri tipi di impaginazione supportati da Self-Service Sources (Batch SDK):
CONTINUATION_TOKEN
Un tipo di impaginazione del token di continuazione restituisce un token stringa che indica l’esistenza di più elementi che non possono essere restituiti, a causa di un numero massimo predeterminato di elementi che possono essere restituiti in una singola risposta.
Un’origine che supporta il tipo di token di continuazione dell’impaginazione può avere un parametro di impaginazione simile a:
Tipo di impaginazione utilizzato per restituire i dati.
continuationTokenPath
Il valore che deve essere aggiunto ai parametri della query per passare alla pagina successiva dei risultati restituiti.
parameterType
Il parameterType definisce dove parameterName deve essere aggiunto. Il QUERYPARAM tipo ti consente di aggiungere la query con il parameterName. Il HEADERPARAM consente di aggiungere parameterName nella richiesta di intestazione.
parameterName
Nome del parametro utilizzato per incorporare il token di continuazione. Il formato è il seguente: {PARAMETER_NAME}={CONTINUATION_TOKEN}.
delayRequestMillis
Il delayRequestMillis nell’impaginazione consente di controllare la frequenza delle richieste effettuate all’origine. Alcune origini possono avere un limite al numero di richieste che è possibile effettuare al minuto. Ad esempio: Zendesk ha un limite di 100 richieste al minuto e definisce delayRequestMillis a 850 consente di configurare l’origine per effettuare chiamate a circa 80 richieste al minuto, ben al di sotto della soglia di 100 richieste al minuto.
Di seguito è riportato un esempio di risposta restituita utilizzando il tipo di token di continuazione impaginazione:
Il PAGE tipo di impaginazione consente di scorrere i dati restituiti per numero di pagine a partire da zero. Quando si utilizza PAGE tipo di impaginazione, devi fornire il numero di record dato in una singola pagina.
Tipo di impaginazione utilizzato per restituire i dati.
limitName
Il nome del limite attraverso il quale l’API può specificare il numero di record da recuperare in una pagina.
limitValue
Il numero di record da recuperare in una pagina.
pageParamName
Il nome del parametro che è necessario accodare ai parametri di query per poter attraversare pagine diverse dei dati restituiti. Ad esempio: https://abc.com?pageIndex=1 restituisce la seconda pagina del payload di ritorno di un’API.
maximumRequest
Il numero massimo di richieste che un’origine può effettuare per una determinata esecuzione incrementale. Il limite predefinito corrente è 10000.
NONE
Il NONE il tipo di impaginazione può essere utilizzato per origini che non supportano nessuno dei tipi di impaginazione disponibili. Origini che utilizzano il tipo di impaginazione NONE è sufficiente restituire tutti i record recuperabili quando viene effettuata una richiesta GET.
"paginationParams": {
"type": "NONE"
}
Pianificazione avanzata per origini self-service (SDK batch)
Configura la pianificazione incrementale e di backfill dell’origine utilizzando la pianificazione avanzata. Il incremental consente di configurare una pianificazione in cui l'origine acquisirà solo record nuovi o modificati, mentre backfill consente di creare una pianificazione per acquisire i dati storici.
Con la pianificazione avanzata, puoi utilizzare espressioni e funzioni specifiche della tua origine per configurare pianificazioni incrementali e di backfill. Nell’esempio seguente, il Zendesk origine richiede che la pianificazione incrementale sia formattata come type:user updated > {START_TIME} updated < {END_TIME} e backfill come type:user updated < {END_TIME}.
Tipo di pianificazione che verrà utilizzato dall'origine. Imposta questo valore su ADVANCE per utilizzare il tipo di pianificazione avanzata.
scheduleParams.paramFormat
Il formato definito del parametro di pianificazione. Questo valore può essere lo stesso del scheduleStartParamFormat e scheduleEndParamFormat valori.
scheduleParams.incremental
La query incrementale dell’origine. Incrementale si riferisce a un metodo di acquisizione in cui vengono acquisiti solo dati nuovi o modificati.
scheduleParams.backfill
La query di retrocompilazione dell’origine. Il backfill si riferisce a un metodo di acquisizione in cui vengono acquisiti dati storici.
Dopo aver configurato la pianificazione avanzata, è necessario fare riferimento a scheduleParams nella sezione URL, body o header params (Parametri URL, corpo o intestazione), a seconda di ciò che supporta la tua specifica origine. Nell’esempio seguente, {SCHEDULE_QUERY} è un segnaposto utilizzato per specificare dove verranno utilizzate le espressioni di pianificazione incrementale e di retrocompilazione. Nel caso di un Zendesk origine, query viene utilizzato in queryParams per specificare la programmazione avanzata.
Aggiungi uno schema personalizzato per definire gli attributi dinamici della tua origine
Puoi includere uno schema personalizzato nel tuo sourceSpec per definire tutti gli attributi necessari per l'origine, inclusi quelli dinamici. È possibile aggiornare la specifica di connessione corrispondente dell’origine effettuando una richiesta PUT al /connectionSpecs endpoint del Flow Service , fornendo al tempo stesso lo schema personalizzato nel sourceSpec sezione della specifica di connessione.
Di seguito è riportato un esempio di schema personalizzato che è possibile aggiungere alla specifica di connessione dell'origine:
Con le specifiche sorgente compilate, puoi procedere alla configurazione delle specifiche di esplorazione per l’origine che desideri integrare in Platform. Consulta il documento su configurazione delle specifiche di esplorazione per ulteriori informazioni.
