Xportcn KA client
  1. Message service access
Xportcn KA client
  • English version
    • API Reference
      • Basics
        • Get user address information
        • Address added and updated
      • Warehouse logistics
        • Please refer to the estimated overseas freight
        • Order overseas freight preview
        • Create international logistics orders
        • Update domestic logistics information
      • KA
        • Interface description flowchart
        • AlibabaProduct
          • AlibabaProductKeywordsQuery
          • AlibabaProductImageQuery
          • AlibabaProductCategory
          • AlibabaProductDetail
          • AlibabaProductFreightEstimateGet
          • AlibabaProductPoolList
        • AlibabaOrderController
          • Order list
          • Order Preview (The preview interface needs to be called before creating an order)
          • Create an order
          • Get order details
      • wms
        • Package forecasting
        • package inbound
        • package update
    • Product Documentation
      • Announcement
      • Summarize
      • Beginner's guide
        • Become a developer
        • Obtain the Access Key and Access key
        • Start development
      • API tutorial
        • Development manual
        • Error code
      • Message service access
        • Message access manual
      • Account test
        • 1688 Test account
      • Q&A
        • Merchandise store search screening
  1. Message service access

Message access manual

Access Instructions#

The message service is an active push service launched by the Xport developer platform to improve efficiency, and the push content is currently only open to order-related messages. Based on this push service, the application no longer needs polling API to obtain distribution data, but only needs the open platform to actively push business content to the developer when the business data corresponding to the message changes, and the developer only needs to subscribe to the message in advance and analyze the message content. It should be noted that since the order of messages cannot be guaranteed, some messages need to be synchronized with the OpenAPI query interface. Message access can effectively reduce API call frequency and reduce system pressure.

Subscribe Steps#

Location: Open Platform Application Console - Messaging Service
Steps: Developers can configure a callback URL on the open platform to receive message requests
Login to the Xport Open platform as a developer;
Select the console;
Select the message service;
Enter the callback address and select Verify. If the HTTP 200 status code is returned, the verification is successful.
Select Save.
image.png

Message format#

messageType: indicates the message type
messageBody: indicates the message body
messagePlatform: Message channel 0-Taobao platform 1-1688 platform
timestamp: Message push time
image.png

Mechanism description#

Callback address#

Description: Developers need to provide a message receiving channel, receiving push in the form of HTTPS POST requests.
To use the message service, you need to prepare a callback interface for receiving messages. Perform the following operations:
Use the HTTPS callback address.
After receiving the message, return the HTTP 200 status code to confirm the message signing.
The timeout period is 1000MS.

Retry and compensation#

If the message fails, it will be pushed again half an hour later, with a maximum of 5 retries.
If the system is interrupted for more than five times, obtain data again through related query interfaces.

Message signature#

Description: Data will be transmitted in plain text. For security reasons, the open platform will perform summary signature processing on the message body, and the signature result will be placed in the Authorization field of the POST request header. The signature algorithm is as follows:
#Request signature parameters
Base = "{messageBody}"
Secret = "{AccessSecret}"
#Signature algorithm
HMAC-SHA256
#Generate signature
Authorization = HEX_ENCODE(HMAC-SHA256(Base, Secret));
Java signature code reference:
image.png
image.png

Handling Suggestions#

After receiving the message, verify the signature to prevent external attacks, and do not convert or modify the original message body when signing! Otherwise, signature matching will be inconsistent.
Note: messageBody is a string.
Because the interface response time is limited (within 1000ms), the message can be stored in the asynchronous queue for service processing.
Modified at 2025-08-19 06:50:46
Previous
Error code
Next
Account test
Built with