The DataWorks open platform provides the following modules for you to integrate DataWorks with your applications and subscribe to related messages: OpenAPI, OpenEvent, and Extensions. The OpenAPI module allows your applications to interact with DataWorks to facilitate data flow management, data governance, and O&M. The OpenEvent and Extensions modules allow you to detect important changes in DataWorks and respond to the changes at the earliest opportunity.
Permission description
Only open platform administrators and tenant administrators have the read and write permissions on the developer backend. Other tenant-level roles and workspace-level roles have only read-only permissions on the developer backend and cannot perform operations such as copying, viewing, or resetting Kafka user passwords. For more information, see Manage permissions on global-level services.
Go to the Open Platform page
Log on to the DataWorks console. In the top navigation bar, select the desired region. In the left-side navigation pane, choose . The Developer Backend tab appears.
You can view all modules of Open Platform, switch to the region where you want to use Open Platform, and view the typical scenarios of Open Platform.
Modules
OpenAPI
The OpenAPI module allows you to call DataWorks API operations so that you can integrate your applications with DataWorks and mine DataWorks services. This can help facilitate big data processing, reduce manual operations and O&M operations, minimize data risks, and lower costs for enterprises. On the OpenAPI tab, you can view the usage of the free quota that DataWorks provides for API calls per month and the number of API calls that you have made in the current month. You can also specify a date range and check API call details within the range.
For more information about the OpenAPI module, see OpenAPI.
OpenEvent
The OpenEvent module allows you to subscribe to DataWorks change events related to your applications so that you can detect and respond to the changes at the earliest opportunity. For more information about the OpenEvent module, see OpenEvent.
Extensions
You can use the OpenEvent module to subscribe to event messages that are generated in your DataWorks workspace. You can use the Extensions module to register programs as DataWorks extensions. Then, you can configure extensions to check and respond to extension point events to manage extension point events and processes.
For more information about the Extensions module, see Extensions.