Skip to main content
API docs by Redocly

Data push interface definition

Download OpenAPI specification:Download

Service interface provided by data push:

Authentication

Sign

Security Scheme Type: API Key
Header parameter name: Authorization

webhook

Data push

Query the list of business topics available for subscription by pagination

  • Query the list of business topics that the current platform supports external subscriptions
  • Optional items: current, default 1
  • Optional items: pageSize, default 10, pageSize maximum 500
Authorizations:
Sign
query Parameters
current
integer
Default: 1

The number of pages to turn, starting from 1

pageSize
integer
Default: 20

Number of elements returned per page (default 20, maximum 500)

Responses

Response samples

Content type
application/json
{
  • "list": [
    ],
  • "pagination": {
    }
}

Business Topic Subscription

  • Externally subscribe to business topics supported by the platform through this interface, and support batch subscription topics
  • Mandatory items: tenantId (tenant id)
  • Mandatory items: appId
  • Mandatory items: webhookUrl( Registered callback interface address, used to receive data)
  • Optional items: topicList, select the topic that needs to be subscribed, if there is a previous registration, then this registration will overwrite the previous subscription. If you leave it blank, it means no subscription, if you have registered before And if you subscribe, the previous subscription will remain unchanged
Authorizations:
Sign
Request Body schema: application/json
tenantId
string

tenant id

appId
string

app id

webhookUrl
string

Registered callback interface address, used to receive data.

topicList
Array of strings

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "appRegisterId": 2646255255224320,
  • "topicHistoryStatusList": [
    ]
}

Change the history message of the specified subscribed business topic to have been processed

  • Usually when historyStatus=false in the parameter returned after calling the /topics/subscribe interface, the subscriber needs to call the full volume of the business topic (see the full volume synchronization interface chapter on the homepage for details). The interface synchronizes the full volume of historical data, and then Then call this interface to inform the platform that incremental business data can be pushed.
  • Mandatory item: tenantId (tenant id)
  • Mandatory item: appId
  • Optional item: topicList, select the one that needs to change the status of historical messages Theme. If left blank, no theme will be changed.
Authorizations:
Sign
Request Body schema: application/json
tenantId
string

tenant id

appId
string

app id

topicList
Array of strings

Responses

Request samples

Content type
application/json
{
  • "tenantId": "dt",
  • "appId": "App_ca4f1aeb382142849cebadb8b780c9ed",
  • "topicList": [
    ]
}

Response samples

Content type
application/json
{
  • "data": true
}

Immediately activate the business topic push task that stopped running due to a callback exception

Usually when the subscriber service restarts abnormally, call this interface to re-push the data; or if you find that the data of the two parties is inconsistent, you can try to call this interface to re-push the data.

Authorizations:
Sign

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "message": "string"
}