如何调用API

鉴权认证

接口说明

调用此接口可以获取登入token

URI

POST /v1.0/openapi/auth/login

PORT

58081

请求参数

请求Body参数

参数	是否必选	参数类型	描述
username	是	String	参数说明：username即登入平台的用户名，默认为admin。
password	是	String	参数说明：password即登入平台的密码。

响应参数

参数	参数类型	描述
code	Integer	参见状态码。
success	Boolean	是否调用成功。true：调用成功，false：调用失败。
t	Integer	毫秒时间戳。
result	Object	详细内容参见下方表格

Object表

参数	参数类型	描述
access_token	String	access_token。
expire	Integer	过期时间。
refresh_token	String	刷新token。

提示

获取access_token后，再调用其他接口时，您需要在请求消息头中添加“x-token”，其值为获取到的access_token。例如Token值为“ABCDEFJ....”，则调用接口时将“x-token: ABCDEFJ....”加到请求消息头即可，如下所示。

GET http://127.0.0.1:58081/v1.0/openapi/createProduct
Content-Type: application/json
x-token: ABCDEFJ....

请求示例

curl --location 'http://127.0.0.1:58081/v1.0/openapi/auth/login' \
--header 'Content-Type: application/json' \
--data '{
    "username":"admin",
    "password":"123456"
}'

响应示例

{
    "code": 0,
    "success": true,
    "t": 1686386096216,
    "result": {
        "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY4NjM5MzI5NiwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjg2Mzg2MDk2fQ.jtD5t23hfs21PdHV6qeqqhqU2o17BJ4KS0rXqdUOsh0",
        "expire": 1686393296,
        "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY4NzU5NTY5NiwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjg2Mzg2MDk2fQ.cY44sa53utIzffs5zDwvae0esTMawgZAL3h3BzPXfJM"
    }
}

刷新access_token

接口说明

调用此接口可以刷新token

URI

POST /v1.0/openapi/token/{refreshToken}

PORT

58081

请求参数

路径参数

参数	是否必选	参数类型	描述
refreshToken	是	String	参数说明：username即登入平台的用户名，默认为admin。

响应参数

响应body参数

参数	参数类型	描述
code	Integer	参见状态码。
success	Boolean	是否调用成功。true：调用成功，false：调用失败。
t	Integer	毫秒时间戳。
result	Object	详细内容参见下方表格

参数	参数类型	描述
access_token	String	access_token。
expire	Integer	过期时间。
refresh_token	String	毫秒时间戳。

请求示例

curl --location --request POST 'http://127.0.0.1:58081/v1.0/openapi/token/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY4NzYwMDIzNCwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjg2MzkwNjM0fQ.yG6om2n8GbNidXkAZENkOJiJMQ4CcggDomtiHE591rk'

响应示例

{
    "code": 0,
    "success": true,
    "t": 1686386096216,
    "result": {
        "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY4NjM5MzI5NiwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjg2Mzg2MDk2fQ.jtD5t23hfs21PdHV6qeqqhqU2o17BJ4KS0rXqdUOsh0",
        "expire": 1686393296,
        "refresh_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJJRCI6MSwiVXNlcm5hbWUiOiJhZG1pbiIsImV4cCI6MTY4NzU5NTY5NiwiaXNzIjoiZWRnZS1nYXRld2F5IiwibmJmIjoxNjg2Mzg2MDk2fQ.cY44sa53utIzffs5zDwvae0esTMawgZAL3h3BzPXfJM"
    }
}