docs: update API docs

This commit is contained in:
JustSong 2024-04-05 01:29:22 +08:00
parent f8cc63f00b
commit ca3228855a
2 changed files with 11 additions and 1 deletions

1
.gitignore vendored
View File

@ -8,3 +8,4 @@ build
logs
data
/web/node_modules
cmd.md

View File

@ -42,3 +42,12 @@ One API 使用 JSON 格式进行请求和响应。
"remark": "充值 100000 额度"
}
```
## 其他
### 充值链接上的附加参数
One API 会在用户点击充值按钮的时候,将用户的信息和充值信息附加在链接上,例如:
`https://example.com?username=root&user_id=1&transaction_id=4b3eed80-55d5-443f-bd44-fb18c648c837`
你可以通过解析链接上的参数来获取用户信息和充值信息,然后调用 API 来为用户充值。
注意,不是所有主题都支持该功能,欢迎 PR 补齐。