Publish Data API
TapData Enterprise can be deployed in your local data center, making it suitable for scenarios with strict requirements on data sensitivity or network isolation. It can serve to build real-time data warehouses, enable real-time data exchange, data migration, and more.TapData supports publishing table data as APIs, aiding enterprises in building a unified data services platform. Various applications can use these APIs to provide support for services such as push notifications. The recommended sequence of use is as follows:
| Step | Description |
|---|---|
| Create an API Application | Manage based on the purpose of the API in groups. |
| Create an API Service | Select the tables to associate, set the API's name, version, access path, permission scope, etc. Once set up, publish it online. |
| Create an API Client | Set the scope of permissions and authentication methods based on business needs to ensure the security of the API service. |
| Invoke API Service | Supports RESTful and GraphQL access methods. |
| Audit and Monitor | Audit and monitor API usage to meet compliance and security requirements. |
📄️ Manage Application
To better manage and distinguish API services, we can categorize them based on business needs, assigning different APIs into different applications. This article introduces the specific operation process.
📄️ Create Data API
To help developers easily dock interfaces and conveniently view API information published through TapData, we offer a data services feature.
📄️ Create a Client
To manage and create API calls, an API client is required. Applications that developers design and develop, or any other applications needing to call API interfaces (referred to collectively as client applications), must register with the data publishing system. Upon registration, you will receive a unique client ID (clientid) and client secret (clientsecret).
📄️ Create a Server
API servers can be configured to expose API server addresses externally, and multiple servers can also be added.
📄️ Service Auditing
Service auditing is primarily used to view the access records of APIs. You can view the records of each request, including access type, personnel, IP address, access time, access result, failure reason, etc. You can also filter according to different conditions.
📄️ API Status Monitor
Service Monitoring allows for the oversight and management of API requests on the platform, providing a view into global statistics and the status of each API.
📄️ API Authentication
TapData's API authentication service is based on the OAuth 2.0 mechanism, with default support for client credentials and implicit authorization methods. You can select the authorization method when creating a client. This article introduces the API authentication process, including how to obtain access tokens, to help you quickly utilize the API service.
📄️ Query API through RESTful
RESTful API is an application programming interface (API or Web API) that adheres to REST architectural specifications. TapData supports integrated RESTful API services, allowing you to execute requests through the API service address and obtain managed data information.
📄️ Query API via GraphQL
GraphQL provides a query language that allows you to request data from the server in a declarative way, such as specific data in a schema. TapData has integrated GraphQL, allowing you to execute requests through the API service address.
📄️ API Query Parameters
When invoking published API interfaces, it's possible to add query conditions in the URL query string to quickly filter the query results. This article introduces supported filters and provides related usage examples.