CCash/docs/connected_services/how_to/endpoints.md
2021-07-05 00:45:59 -07:00

1.6 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 406

Jreq - Json Request, requires application/json as content-type, failing to do so results in 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 401

U - User, requires basic auth in the header Authorization. This credential must be a valid user, failing to do so results in 401

✔️ ✖️

Usage endpoints

name purpose json input path HTTP Method Jresp Jreq A U return type return value v1
GetBal retrieving the balance of a given user N/A api/v1/user/balance?name={name} GET ✔️ ✖️ ✖️ ✖️ JSON uint32 the user's balance ✔️