守护助手

创建共享

POST

/share/create

共享相关接口

接口需要登录才能访问，token使用header头Authorization

请求参数

Header 参数

Authorization

string

token

必需

示例值:

Body 参数application/json

shareType

integer <int32>

必需

分享类型,1:位置共享，2：行程共享

示例

{
    "shareType": 0
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://guardian-api.itheima.net/share/create' \
--header 'Authorization: {{token}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "shareType": 0
}'

返回响应

🟢200OK

application/json

Body

code

integer <int32>

必需

请求码，200为成功，300及300以上为请求失败

msg

string

响应信息

可选

resTime

string <date-time>

响应时间

可选

result

object (创建共享结果模型)

可选

shareId

integer <int64>

共享id

可选

tips

string

可选

示例

{
    "code": 0,
    "msg": "string",
    "resTime": "2019-08-24T14:15:22Z",
    "result": {
        "shareId": 0
    },
    "tips": "string"
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

修改于 2024-02-29 10:15:07

接收者-共享推送websocket接口

结束共享