mirror of
https://github.com/Expand-sys/CCash
synced 2025-12-17 00:22:14 +11:00
2.3 KiB
2.3 KiB
API endpoints
KEY
Jresp - Json Response, json must be accepted in the Accept header, be that via application/json or */*, failing to do so results in error 406
Jreq - Json Request, requires application/json as content-type, failing to do so results in error 406
A - Admin, requires basic auth in the header Authorization. This credential must be both a valid user and have a username of that of the admin account, failing to do so results in error 401
U - User, requires basic auth in the header Authorization. This credential must be a valid user, failing to do so results in error 401
✔️ ✖️
Usage endpoints
| name | purpose | json input | path | HTTP Method | return type | return value | Jresp | Jreq | A | U |
|---|---|---|---|---|---|---|---|---|---|---|
| GetBal | retrieving the balance of a given user, {name} |
N/A |
api/v1/user/balance?name={name} |
GET |
uint32 | the user's balance | ✔️ | ✖️ | ✖️ | ✖️ |
| GetLog | retrieves the logs of a given user, length varies by server configuration | N/A |
api/v1/user/log |
GET |
array of jsons | {"to":string, "amount":uint32, "time":int64} |
✔️ | ✖️ | ✖️ | ✖️ |
Usage endpoints support
v denoting the API version
| name | v1 |
|---|---|
| GetBal | ✔️ |
| GetLog | ✔️ |