The DataWorks Open Platform gives applications programmatic access to DataWorks through three integration modules: OpenAPI, OpenEvent, and Extensions. Use OpenAPI to automate data workflows, OpenEvent to react to platform changes without polling, and Extensions to inject custom logic into DataWorks processes.
Permissions
Only Open Platform Administrator and Tenant Administrator roles have read and write permissions on the Developer Backend. All other tenant-level and workspace-level roles have read-only access and cannot perform operations such as copying, viewing, or resetting Kafka user passwords. For details, see Manage permissions on global-level services.
Open the Developer Backend
Log on to the DataWorks console.
In the top navigation bar, select a region.
In the left-side navigation pane, choose More > Open Platform.
On the page that appears, click Go to Open Platform.
The Developer Backend tab opens. From here, switch regions, view all modules, and explore typical integration scenarios.
Open Platform is supported only on PC Chrome browsers version 69 or later.
Modules
| Module | What it does | Get started |
|---|---|---|
| OpenAPI | Call DataWorks API operations from your applications to automate data flow management, data governance, and O&M—reducing manual effort and data risks at scale. The OpenAPI tab shows your monthly free quota, current-month call count, and call details for any date range. | OpenAPI |
| OpenEvent | Subscribe to DataWorks change events so your application is notified the moment something changes. | OpenEvent |
| Extensions | Register custom programs as DataWorks extensions, then attach them to extension points to check and respond to platform events within your workspace. | Extensions |
Choose a starting point
Automating data pipelines or integrating DataWorks into an existing system: start with OpenAPI.
Triggering downstream actions when DataWorks jobs change state: start with OpenEvent.
Injecting custom processing logic into DataWorks workflows: start with Extensions.