Connect a Web REST API with Bold Data Hub

The Bold Data Hub Web connector fetches data from a REST API into Bold Reports^® and supports nested JSON fields.

What are the limits of the Web connector?

The Bold Data Hub Web connector has the following limitation:

Supports JSON response only.

Connection Properties

The Web connector in Bold Data Hub reads the following properties from the config section of a YAML file:

url: URL
username: Username
password: Password
type: HHTP method either GET/POST
headers: Header parameters
params: Query Paramaeter value
data: Data value

Example Configuration

The following Bold Data Hub YAML template shows a complete Web extractor configuration:

version: 1
encrypt_credentials: false
plugins:
  extractors:
    - name: web
      #Json Response only supported
      connectorname: Web
      config:
        url: url
        # Basic Authentication
        username: username
        password: password
        type: get
        headers: { 'ContentType': 'application/json' }

How do I connect a REST API in Bold Data Hub?

You connect a REST API by creating a project in Bold Data Hub and adding the Web template to it.

Click the Data Hub icon on the Navigation Pane.
Click Add Project and enter a name for the new project.
Select the newly created project and add the Web template.
Update the required details in the template, using the configuration parameters below.
Click Save and choose the destination to save the pipeline.

Creating a pipeline in Bold Data Hub automatically creates a data source in Bold Reports^®. The Bold Reports^® data source is a live data source to the destination database used in Bold Data Hub.

Configuration Parameters

The Web template in Bold Data Hub uses these parameters:

Parameter	Description
URL:	Specify the URL of the web service from which data will be extracted. This URL should point to the API endpoint providing the required data.
Authentication (Optional):	Username: If the web service requires basic authentication, provide the username here. Password: Corresponding password for basic authentication.
Request Type:	Specify whether the connector should use the GET or POST method for making requests to the API.
Parameters (Optional):	Provide parameters required for the API call in JSON format - key-value pairs. These parameters are typically used for filtering or customizing the data returned by the API.
Data (Optional):	If the API call requires any additional data to be sent, specify it here in JSON format - key-value pairs. This data might include payload or request body parameters.
Headers (Optional):	Include any custom headers required for the API call. These headers should be provided in JSON format, specifying key-value pairs such as content type or authentication tokens.

How do I schedule the Web pipeline?

You schedule the Web pipeline in Bold Data Hub from the schedules tab, or you run it on demand.

To configure interval-based scheduling, click the schedules tab, select the created pipeline, click the schedule icon, and configure the schedule.
For an on-demand refresh, click the Run Now button.
Check the schedule history with the history option and the logs.
Click Logs to see whether the run is completed and the data source is created in Bold Reports^®.
Click the Edit DataSource option to view the created tables.