HTTP GET Data Source

 

This feature is available on the following tier: Enterprise, Advanced.

 

About

The HTTP GET Data Source allows ProntoForms to retrieve data from a web application or data storage system accessible through the internet through an HTTP GET request, and is typically used to set up a custom integration.   

The data retrieved by this data source can then be used to populate a list of options in dropdown or radiobutton questions in a form, or populate additional answers based on a selection.

 

Tips for System Integrators:
  • This data source can use any API request that uses the GET method.  Usually this is for requests named something like "Retrieve a List of Records".

 

Basic Setup

  1. Create the data source as described here.
  2. Select HTTP GET Data Source as the type.
  3. Select a Name and optionally enter a Description.
  4. Set up the data source using the information below. 

[ top ]

 

Data Retrieval and Format

Push updates to device after a fetch

If turned on, users will get a notification from the ProntoForms app after a fetch. It will prompt users to reconcile (send/receive or refresh).   This setting is recommended if it is important that users have the most up-to-date data.  

retrieval_andformat.png

[ top ]

 

Fetch Schedule

retrieval_andformat.png

Automatically fetch new data on a schedule:

  • If checked, data will be retrieved at the specified Fetch Frequency interval. 
    • Make sure that the team has a Problem Contact Email Address. If a fetch is unsuccessful for any reason, this address will receive an  email with an error message and details.  Without this email, it may not be immediately clear that a fetch has failed.  
  • If unchecked, the data source will not be updated automatically.   To retrieve new data, the data source will need to be manually updated through the "Fetch New Data" button on the data source's details page in the web portal. 

Fetch Frequency:

Choose Hourly, Daily, Weekly or Monthly.  This is how often the data source will fetch new data from the data source. 


Fetch Timezone:  This applies to all fetch frequency options except “Hourly.”  The data retrieval will occur at midnight in the specified time zone, at the specified interval. 

[ top ]

 

Input Configuration:

inputconfig.png

Data Format

Be sure to choose the data format that is going to be returned by the system you are integrating with.  To be certain, look at their API documentation for the GET call you would like to make.  In the Sample Response Body, it will show you the format.  

 

Other Settings

  • UTF-8 Encoded: This is not relevant for JSON or XML. 
  • Trim Whitespace: This option will remove any space, tab, or other "whitespace" characters that may be present at the beginning or end of a data value.  This is recommended.
  • CSV Delimiter: This option is relevant only when uploading a CSV file.  When saving to delimited format from a spreadsheet application, comma is generally used as the separating character, but semi-colon may be used by some applications in some regions.

[ top ]

 

Connection

Connection

Configure a new HTTP Connection or choose an existing connection.

 

URL Suffix

In your HTTP Connection, you will have set up a Base Connection URL, which is usually the first part of the URL that will be used by all your data sources and destinations.   

In the data source URL Suffix field, you enter the remainder of the URL.  This is the part that is usually unique, and specifies exactly which object to retrieve data from.  

 

How can I find this value?

Go to the API documentation for the system you would like to connect to, and find the documentation for a GET call, like "GET - Retrieve a list of Records."  

It will show the the required URL format. In the example below, the URL is completed with the ID and name of the actual resource I want to write to; other API docs may require you to find this value yourself. 

Be sure to:

  • Exclude any special characters that are not part of the URL, like quotes or backslashes (see above)
  • Ensure that the Base Connection URL combined with the URL Suffix form a valid URL
    • One common mistake is to omit the slash between them

 

HTTP Headers

Some systems may require you to send additional headers when making the GET request.  This will be specified in their documentation.

For example, the sample request below from 3rd party API documentation indicates that a header is required by the -H line in the request.     



For systems that only provide an Authentication token, often they specify that this must be sent as a header.

[ top ]

 

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

  • Avatar
    Joseph Holt

    Get way of building dynamic content from external sources.

  • Avatar
    Danielle Morley

    Hello Joseph,

    Cam you clarify what you are referring to?  Perhaps you can explain a scenario/use case that would make your request clearer.

  • Avatar
    Jeffrey Moya

    Hi,

     

    How do I setup a connection prefix that requires a get parameter e.g. /user/{:userid:}

     

    Thanks

  • Avatar
    Scott Daly

    Hi Jeffrey, there may be a way to accomplish this using Partitions.  I will create a ticket now and we'll follow up with further guidance.