API management

DataService Studio lets you build, publish, and govern data APIs without writing a backend service. Connect to a data source, configure query logic, and expose the result as a callable REST API — all within DataWorks.

Use API management when you need to give downstream applications or teams controlled, on-demand access to specific datasets. For bulk data transfers or large-scale exports, use data synchronization solutions instead.

Who this section is for

API management covers two distinct workflows depending on your role:

• API publishers — data engineers or analysts who create APIs backed by a data source, test and publish them, and control who can call them.

• API consumers — application developers or data consumers who discover published APIs, request authorization, and integrate the APIs into their applications.

Publish an API

Follow these steps to build and publish a data API:

1. Create an API. Generate an API from a data source using the codeless UI (no SQL required) or the code editor (for custom SQL queries). Alternatively, register an existing external HTTP/HTTPS service to centrally manage it in DataService Studio.

2. Test the API. Run test calls against the API before publishing to verify query logic, parameter handling, and response format.

3. Publish the API. Publish the API to make it callable. Manage versions to roll back to a previous release if needed.

4. Authorize callers. Grant specific applications or users permission to call the published API.

Call an API

Follow these steps to integrate a published API into your application:

1. Discover the API. Browse available APIs in the DataService Studio service catalog and identify the one that serves your data need.

2. Request authorization. Contact the API publisher to get call permission for your application.

3. Call the API. Use the authorization credentials to send requests to the API endpoint from your application.

What you can do