Use the HTTP request API

API call process

API call request address

The Xport Global Open platform provides a set of online production environment, in which the data generated is real and valid online data, the request address is as follows

API request address: https://www.xportcn.com

Request and response

The Xport Global Open Platform API supports both HTTP and HTTPS communication protocols. To ensure data security, it is recommended to use the HTTPS protocol to make API requests.

All API requests return a response result that shows the status of the return (success or error) and may provide results or detailed data related to the specified request, in the format of JSON.

Request parameters

All API request parameters include system parameters and service parameters.

System parameters

All API requests require the following ** system parameters **, as detailed in the following table:

Name	Type	Is	required Is used as a sign argument	Description
access-key	String	yes	yes	is the AccessKey
timestamp	String	yes	yes	Time when the request is sent. Use the UTC timestamp and ensure that the request time cannot exceed 600 seconds from the UTC time
once-str	String	yes	yes	A random string of 32 characters
user-id	String	yes	no	is used to control the rights of the subaccount
signature	String	yes	no	The interface signature is used to verify the request. For details, see

Note that all ** system parameters ** must be stored in **HTTP header request headers **.

Business parameters

In addition to system parameters must be included in the * * * *, all API request must contain the corresponding parameters of * * * * business, the business of each API parameters can be found in the reference [API] (https://doc-en.xportcn.com/?nav=2).

Request a response

The request response data format of all apis is JSON. The format reference is as follows:

Name	Type	Description
requestId	String	Indicates the request id. You can query the log
code	Integer	The return code
developId	String	developer id
msg	String	Corresponding to the return code
data	Object	Returns the content

Sample request response:

{
    "requestId": "4cfda0b725184ab8a1e3ee3b9051ec35",
    "code": 200,
    "developId": "1014533973088404335",
    "msg": "成功",
    "data": {
        "quantity": 400,
        "categoryPath": "童装/婴儿装/亲子装->裙子(新)->连衣裙",
        "shopName": "u[2206891060210]",
        "description": "测试",
        "productUnit": null,
        "picUrls": [
            "https://img.alicdn.com/bao/uploaded/i1/263669477/O1CN01fH0cbf2JsW8fvHFwx_!!263669477.jpg"
        ],
        "title": "天穹发布商品，测试请不要拍",
        "mpId": "2048057995392326",
        "categoryName": "连衣裙",
        "itemId": 672991141190,
        "userNick": "测试账号tbc003",
        "price": 1,
        "beginAmount": 0,
        "status": "active",
        "promotionPrice": 1,
        "shopId": 268763467,
        "categoryId": "121452038",
        "itemType": "HAVE_MATERIAL",
        "skuList": [
            {
                "picUrl": null,
                "quantity": 200,
                "price": 1,
                "skuId": "3452545926724",
                "status": "active",
                "promotionPrice": "1",
                "postFee": 0,
                "mpSkuld": null,
                "properties": [
                    {
                        "valueId": 28326,
                        "valueName": "红色",
                        "propId": 1627207,
                        "propName": "颜色分类"
                    },
                    {
                        "valueId": 3273546,
                        "valueName": "52cm",
                        "propId": 122216343,
                        "propName": "参考身高"
                    }
                ]
            },
            {
                "picUrl": null,
                "quantity": 200,
                "price": 1,
                "skuId": "3452545926725",
                "status": "active",
                "promotionPrice": "1",
                "postFee": 0,
                "mpSkuld": null,
                "properties": [
                    {
                        "valueId": 28324,
                        "valueName": "黄色",
                        "propId": 1627207,
                        "propName": "颜色分类"
                    },
                    {
                        "valueId": 3273546,
                        "valueName": "52cm",
                        "propId": 122216343,
                        "propName": "参考身高"
                    }
                ]
            }
        ]
    }
}

Parameter signature

The Xport Global Open Platform verifies the identity of each API request, and the server verifies that the request parameters are valid. Therefore, every HTTP request must contain signature data, and requests with invalid signatures will be rejected.

The Xport Global Open Platform verifies the identity of a request through an AccessKey and an AccessSecret assigned to the developer. The AccessSecret is used to generate a signature string during HTTP requests. Please keep your AccessSecret strictly confidential.

The signature generation process is as follows:
Step 1: Concatenate public request parameters by 'access-key', 'timestamp', 'nonce_str', 'authorization key';
Step 2: Encrypt the string that is concatenated in the first step through md5;
Step 3: Convert all the encrypted strings into uppercase letters to get the final signature (sign).

JAVA Sample code：

PHP Sample code

Development manual

Use the HTTP request API#

API call process#

API call request address#

Request and response#

Request parameters#

System parameters#

Business parameters#

Request a response#

Parameter signature#