TW-API-EN
    • Document Description
    • Request
    • Response
    • V2
      • Get the list of delivery channels
        POST
      • Order trial calculation
        POST
      • Order forecast
        POST
      • Prepaid charge
        POST
      • Order status inquiry
        POST
      • Invoice Enquiry
        POST
      • Order details
        POST
      • Download the label
        POST
      • Order deleted
        POST
      • Query the invoice details
        POST
      • Available banlance
        POST
    • T86
      • Query bag information
        POST
      • Delete the package
        POST
      • Create a package
        POST
      • Review bag
        POST

    Document Description

    Development process#

    flow_new.png
    1.
    Log in to the order making system [Open Platform] to obtain the API KEY and API TOKEN
    2.
    Refer to the document [Signature Algorithm] to construct your signature based on the language used
    3.
    Obtain the list of available products through the "Delivery Channel" interface
    4.
    Obtain the optimal price through "Order Trial Calculation" or "Order Batch Trial Calculation"
    5.
    Forecast your order through [Order Forecast] or [Order Batch Forecast]
    6.
    Obtain the order fee, transfer number and other information through [Order Details]
    7.
    Obtain the download address of the transfer slip through [Download Label]

    Authentication and authentication#

    For HTTP signature requests, the server side will authenticate the identity of the request initiator.

    Encryption method#

    All requests are encrypted using symmetric encryption

    Mandatory parameters to be passed#

    Parameter nameData typeNote
    keystringAPI_KEY
    tintCurrent timestamp
    usernamestringusername
    signstringSignature

    key#

    Developers can obtain API_KEY in the open platform, but they should also pay attention to the development environment

    t#

    Unix timestamp, unit: seconds

    username#

    The login username, for example: TW0001

    sign#

    A 32-bit string composed of numbers and letters, generated by a signature algorithm

    secret#

    "secret" is the key used for data signing and is not passed as a parameter. Developers can obtain API_TOKEN in the open platform

    Signature formula#

    💡
    //Timestamp concatenation key
    sign = md5(secret + '_' + t)

    PHP signature#

    JAVA signature#

    GO signature#

    Modified at 2026-01-04 08:51:41
    Next
    Request
    Built with