Menu

API Interface Header Parameter Acquisition Instructions

Preface

The Header parameter in the API interface request is used to pass information about the request, such as authentication information, data format, client type, etc., to help the server correctly process and respond to the request.

Warning: The signature required to send the request (the signature is the value of the parameter name sorted in lexicographical order and connected to the token for MD5 encryption)

Example values:

Copy
 <code class="language-bash">填写自己项目的&quot;Token&quot;&amp;chat_user_id=64673427382a7760153e9f81&amp;page=1&amp;page_size=50&amp;project_id=1
</code>

Warning: API interface document 必需 field must be passed!

填写自己项目的"Token" Get it in 项目设置-企业开发设置-API Token!!! warning Warning: This function is only supported in Max version, not in Pro version. Please check the SaleSmartly price for details
!!!

Signature Steps

1. Parameter sorting

  • First, sort all request parameters in lexicographical order (that is, alphabetical order AZ).

Warning: The token always comes first. Only parameters get sorted.

Copy
 <code class="language-字母表顺序是按照以下顺序排列的">a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p, q, r, s, t, u, v, w, x, y, z
</code>
  • For example, suppose your request parameters are:
    • 自己项目的"Token"
    • chat_user_id=64673427382a7760153e9f81
    • updated_time={"start":1680000000,"end":1714027206}
    • page_size=50
    • project_id=此处填写左下角项目id
    • page=1
  • After sorting, the result is:
    • 自己项目的"Token"
    • chat_user_id=64673427382a7760153e9f81
    • page=1
    • page_size=50
    • project_id=此处填写左下角项目id
    • updated_time={"start":1680000000,"end":1714027206}

2. Splicing parameters

  • Connect the sorted parameters together with the & symbol.
  • The concatenated string:
Copy
 <code class="language-bash">填写自己项目的&quot;Token&quot;&amp;chat_user_id=64673427382a7760153e9f81&amp;page=1&amp;page_size=50&amp;project_id=1&amp;updated_time={&quot;start&quot;:1680000000,&quot;end&quot;:1714027206}
</code>

MD5 encryption

Warning: Any changes to the parameter names or values require re-sorting and re-encryption.

The concatenated string is encrypted with MD5 to generate a hexadecimal string with 32位小写 external-sign fields. For example, after the required signature above is encrypted with MD5, you will get:

Copy
 !#twenty three@!
Previous
How to Use the API
Next
Cooperative Promotion
Last modified: 2025-06-27Powered by