Package: tap-jotform
tap-jotformSinger Tap for Jotform. Built with theMeltano Singer SDK.Capabilitiescatalogstatediscoveraboutstream-mapsschema-flatteningSettingsSettingRequiredDefaultDescriptionapi_keyTrueNoneAuthentication key. Seehttps://api.jotform.com/docs/#authenticationapi_urlFalsehttps://api.jotform.comAPI Base URLuser_agentFalsetap-jotform/0.0.1User-Agent headerstart_dateFalseNoneStart date for data collectionrequests_cacheFalseNoneCache configuration for HTTP requestsstream_mapsFalseNoneConfig object for stream maps capability. For more information check outStream Maps.stream_map_configFalseNoneUser-defined config values to be used within map expressions.flattening_enabledFalseNone'True' to enable schema flattening and automatically expand nested properties.flattening_max_depthFalseNoneThe max depth to flatten schemas.A full list of supported settings and capabilities is available by running:tap-jotform --aboutStreamsStream nameAPI endpointAPI docsNotesforms/user/formshttps://api.jotform.com/docs/#user-formsReplication for this stream is opt-in. See instructionsbelow.questions/form/{form_id}/questionshttps://api.jotform.com/docs/#form-id-questionssubmissions/user/submissionshttps://api.jotform.com/docs/#user-submissionsReplication for this stream is opt-in. See instructionsbelow.reports/user/reportshttps://api.jotform.com/docs/#user-reportsuser_history/user/historyhttps://api.jotform.com/docs/#user-historyConfiguring incremental replicationBy default, theformsandsubmissionsstream are synced withFULL_TABLEreplication. Incremental replication can be enabled by setting the replication metadata in the stream's entry in the catalog file:replication_method: set toINCREMENTALreplication_keyset tocreated_atorupdated_at. The former will omit updated submissions, while the latter will omit new submissions.For example, to enable incremental replication for thesubmissionsstream:{"streams":[{"tap_stream_id":"submissions","stream":"submissions","replication_method":"INCREMENTAL","replication_key":"updated_at",}]}Source Authentication and AuthorizationTo generate an API key, follow the instructions inhttps://api.jotform.com/docs/#gettingstarted.UsageYou can easily runtap-jotformby itself or in a pipeline usingMeltano.Executing the Tap Directlytap-jotform--version
tap-jotform--help
tap-jotform--configCONFIG--discover>./catalog.jsonDeveloper ResourcesInitialize your Development Environmentpipxinstallpoetry
poetryinstallCreate and Run TestsCreate tests within thetap_jotform/testssubfolder and
then run:poetryrunpytestYou can also test thetap-jotformCLI interface directly usingpoetry run:poetryruntap-jotform--helpTesting withMeltanoNote:This tap will work in any Singer environment and does not require Meltano.
Examples here are for convenience and to streamline end-to-end orchestration scenarios.Your project comes with a custommeltano.ymlproject file already created. Open themeltano.ymland follow any"TODO"items listed in
the file.Next, install Meltano (if you haven't already) and any needed plugins:# Install meltanopipxinstallmeltano# Initialize meltano within this directorycdtap-jotform
meltanoinstallNow you can test and orchestrate using Meltano:# Test invocation:meltanoinvoketap-jotform--version# OR run a test `elt` pipeline:meltanoelttap-jotformtarget-jsonlSDK Dev GuideSee thedev guidefor more instructions on how to use the SDK to
develop your own taps and targets.