Data as API

Securely share your data with external entities or integrate their data into third-party applications.

Check out the given walk-through on how to publish Data as an API using the Data Center module.

Publishing Data as an API

Data as API is an approach that allows exposing data as Application Programming Interfaces (APIs) for easy access and integration by other systems, applications, or developers. It allows data providers to make their data available and consumable by external parties in a programmatic manner.

Data as API shifts the traditional concept of sharing data by encapsulating the data and its operations within a well-defined API. This enables developers to interact with the data using standard API protocols without getting worried about the underlying storage or implementation details.

• Navigate to the Data Center homepage.

• Click the New option.

• Select the Data As API option from the New menu.

Data As API option under the New menu

• Select a Data Source from the displayed list.

• Click on the Publish As Data Service icon.

Publish as Data Service option

• The Publish As Data Service form opens.

• Provide the following information:

  • Service Name

  • Select a category or create a new Category.

  • Description

  • Parameters

  • Limit (You can specify the no. of records you want in the Limit field).

• Click the Save option.

The Publish As Data Service form

• A confirmation message notifies the users that the selected data source has been published as a service.

• The published data gets listed under the Data as API list.

The newly published data source as API gets listed under the Data As API list

Please Note:

• The user can add filter(s) to the data set as a service.

• The Data Set published as a data service appears under the drop-down menu of the API Client Registration form (as displayed in the below-given image).

Icon	Name	Action
​​	Push to VCS	Pushes a version of the Data as API to VCS
​​	Pull from VCS	Pulls a version from the VCS
​​	Edit	Opens the Publish as Data Service form for the selected Data as API to modify the information.
​​	No data message configuration	A dialog box appears to configure the message that gets displayed when no data is shown under the Published API.
​​	Delete	Deletes the selected Data as API service from the list.