Open platform overview
The DataWorks Open Platform is the official channel for accessing DataWorks data and capabilities. It provides three core features, OpenAPI, OpenEvent, and Extensions, which enable you to quickly connect your applications to DataWorks, streamline data workflow management, governance, and O&M, and respond in real time to business status changes.
Permissions
Only users with the Open Platform Administrator or Tenant Administrator role have read and write permissions for the Developer Backend. All other tenant-level and workspace-level roles have read-only access to the Developer Backend page and cannot copy, view, or reset Kafka user passwords. For more information, see Manage permissions on global-level services.
Access the open platform
Log on to the DataWorks console. In the target region, click in the left-side navigation pane. Click Go to Open Platform to open the Developer Backend page.
This page displays all modules of the Open Platform and allows you to switch regions and explore typical use cases. The left-side navigation pane of the Developer Backend page lists OpenAPI, OpenEvent, and Extensions. The main content area displays API call statistics for the current month, an OpenAPI Call Details list, and links to OpenAPI Best Practices.
The Open Platform is only supported on Chrome version 69 or later for desktop.
Features
-
OpenAPI
Use OpenAPI to programmatically interact with DataWorks services from your own applications. This improves big data processing efficiency, reduces manual O&M, and lowers data risks and costs. In the OpenAPI section, you can also monitor your free quota usage, call counts, and call details.
For more information, see OpenAPI.
-
OpenEvent
OpenEvent provides a message subscription service. You can subscribe to DataWorks events to receive real-time notifications when the status of a resource or job changes. This allows your applications to respond immediately to events, enabling you to build automated and responsive workflows. For more information, see OpenEvent.
-
Extensions
Extensions allow you to register your own services as custom components within DataWorks. Built on the OpenEvent message subscription capability, extensions can intercept and respond to specific event messages. This enables you to inject custom logic for notifications or process control directly into DataWorks workflows.
For more information, see Extensions.