Introduction

PhixFlow allows you to integrate with various APIs to export data. To achieve this you will require three elements.

Table: Contains the data which the HTTP Exporter will provide to the API.
HTTP Exporter: Uses the HTTP Datasource the data from the HTTP Datasource.
HTTP Datasource: provide the information needed to connect to an external source of data via HTTP.

Example

We will connect to the UK Government bank holiday API and return the bank holiday dates for each country. See Bank Holidays for more detail on the API.

Solution

HTTP Datasource

Drag a HTTP Datasource from the toolbar and drop it on the analysis canvas.
In the properties window set the following:
1. Name, Set a name indicative of the API.
2. Enabled, Tick this option.
3. Connection Type, Set this to that of the API, in our example we will use HTTPS.
4. HTTP Datasource Instances, Set the instance connection details. Add a new HTTP Datasource Instance and complete the details as follows:
  1. Name, Indicative of the use of the instance.
  2. Enabled, Tick to use the instance.
  3. Login details can be set if required. see HTTP Datasource for more information.
  4. URL, The URL where the API can be found. For the Gov Bank Holiday API we set this to: www.gov.uk/bank-holidays.json
  5. Click OK.
5. Click OK.

HTTP Collector

Hover your mouse over the HTTP Datasource created in the stage above.
From the popup menu select HTTP Collector. This adds a new HTTP Collector and sets it up to use our HTTP Datasource.
1. You can drag a new HTTP Collector from the toolbar, but you will need to connect it to the HTTP Datasource.
In the properties window that opens on the right set the following:
1. Name, Set a name indicative of the data being collected.
2. Enabled, Tick this to use the collector.
3. HTTP Request Method, This defaults to GET or POST. For our example that is correct. However see HTTP Collector for more information, if your API requires something different.
4. URL Expression, we can reference the URL from the http datasource using the syntax ${_url}. This can be useful if you have a base url in your HTTP datasource, e.g. www.phixflow.com, and you want to append to it in different collectors e.g. ${_url}/myPage1
  1. To reference any of the attributes from the table calling the http collector we use ${_out.attributeName}. We encapsulate the attributes with ${}.
  2. For example, ${_out.token}
5. Statement Expression, this is not required by our example. If your API requires interaction such as when we are requesting a session token, it can be carried our in this statement expression.
6. HTTP Headers, contains information about the request being sent to the API. This is not required for our example. An example header setup is illustrated below, for full details see HTTP Header:
7. Response → Return Type, In the response section set Return Type to JSON. Other types of data can be returned, see HTTP Collector.
8. Response → Path, specifies the data in the JSON you with to return. Most APIs will specify the structure of the data returned, the path is used to filter what is returned. The response utilises xPath Syntax
  1. In our example we only want the bank holidays for each country so we set the value to: $..events
  2. This gives us all countries as we have specified ..
  3. If we want just England and Wales we would specify: $.england-and-wales.events

Table

Hover your mouse over the HTTP Collector created in the stage above.
From the popup menu select Create New Table
1. You can drag a new Table from the toolbar, but you will need to connect it to the HTTP collector.
In the properties window that opens on the right set the following:
1. Name, Set a name indicative of the data being collected.
2. Attributes, Add the attributes you require from your collected data:
  1. Name to Country. Expression to in.^.^.division
  2. Name to Title. Expression to in.title
  3. Name to Date. Expression to toDate(in.date, "yyyy-MM-dd")
3. You can navigate up the JSON nodes using the hat symbol ^. This is seen in the Country attribute above: in.^.^.division
4. You can descend the JSON nodes using .. as a wild card to include all nodes at that level. This is seen in the Response Path of the HTTP Collector to include all countries: $..events
  1. It is also possible to use the specific node name to descend into a specific node in the JSON.

Trouble Shooting

If you return 0 records

Open the System Console
In the Completed Tasks, click on the table that ran
In the Messages section, double-click the line with the message "Response from URL:..."
In the window that opens, click the Message Details tab
The raw data is displayed that is returned from the API.
1. Ensure your Response Path is set correctly to traverse to the required data.

Secured Example

Where we need to use sensitive information, such as a password or token, these can be held in Secret Keys and access using the prefix _datasource.

Secret Key Setup

Open the HTTP Datasource properties,
Navigate to the Secret Keys section,
Add your sensitive information,
1. Name, name the secret key will be referenced by. For example clientSecret.
2. Secret, the secret information to be stored in an encrypted format.
Save all of your changes.
The secret key can now be referenced by HTTP Collectors attached to the HTTP Datasource. It is available to use in the URL Expression and Statement Expression.
To reference the secret key use the syntax: _datasource.secretname.
1. For example, _datasource.clientSecret
2. Example Statement Expression:
  1. client_id=client_secret=${_datasource.clientSecret}&resource=phixflow.com&grant_type=client_credentials

More Information

For more information about the configuration options surrounding HTTP Datasources and Collectors see the following pages:

Exporting Data Through an API