开放能力 Beta
通过 Open API 向码上取App 用户推送自定义通知
消息推送
通过标准的 RESTful API 接口，向安装了码上取App 的 iOS 用户推送自定义通知。 适用于业务系统集成、自动化提醒等场景。
自定义通知
自定义通知图标、标题和内容，自由推送消息
App内同步查看
打卡、提醒、都能推，App内同步查看
API 文档
认证方式
在请求头（Header）或查询参数中传入 key，格式为 keyId.secret
# 请求头方式
Authorization: yourKeyId.yourSecret
# 或查询参数方式
POST /open-api/notification/push?key=yourKeyId.yourSecret
推送通知
POST
/open-api/notification/push
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| title | String | 是 | 通知标题 |
| content | String | 是 | 通知内容 |
请求示例
# cURL 示例
curl -X POST https://mashangqu.xjpz.cc/open-api/notification/push \
-H "Content-Type: application/json" \
-H "key: yourKeyId.yourSecret" \
-d '{
"title": "新消息",
"content": "您有一条新的通知"
}'
响应说明
// 成功响应
{"code": 20000, "msg": "success"}
| 错误码 | 说明 |
|---|---|
| 40001 | 认证失败（key 无效/过期/停用） |
| 40002 | 参数错误（缺少必填字段） |
| 50001 | 用户或推送Token不存在 |
申请 AppKey
使用码上取App 扫码验证身份后，即可自助申请 AppKey。
接入指引
1
使用码上取App 扫码验证身份，自助申请 AppKey
2
使用 keyId.secret 作为请求头中的 Authorization 或urlkey参数进行接口认证
3
调用 /open-api/push 接口推送自定义通知
