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.

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.

  • The user gets redirected to the Data as API page displaying the available Data sets (data).

  • Select a Data Set from the displayed list.

  • Click on the Publish As Data Service icon.

  • 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.

  • 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 Data Set published as a data service appears under the drop-down menu of the API Client Registration form (as displayed in the following image).

Please Note:

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

  • The user needs to register a new client to access the newly published data as an API.

  • Once the data is exported as API, the user can consume it using the API Ingestion component under the Data Pipeline module.

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.

Last updated