API endpoints

PREVIOUS PAGE | NEXT PAGE

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

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

A - Admin, same as U but in addition requires username supplied be equal to the admin account username

✔️ ✖️

all error responses have JSON string along with them to describe

Usage endpoints

name	purpose	json input	path	HTTP Method	correct status	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`	200	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`	200	array of objects	[{"to":string, "amount":uint32, "time":int64}]	✔️	✖️	✖️	✔️
SendFunds	sends funds from the authenticated user to the user `{name}` given in the json	{"name":string, "amount":uint32}	api/v1/user/transfer	`POST`	200	uint32	the user's balance after the transaction	✔️	✔️	✖️	✔️
VerifyPassword	verifies the credentials, used for connected services for ease of use	`N/A`	api/v1/user/verify_password	`POST`	204	`N/A`	`N/A`	✔️	✖️	✖️	✔️

Usage enpoint errors

name	400	401	404	406
GetBal	✖️	✖️	✔️	✔️
GetLog	✖️	✔️	✔️	✔️
SendFunds	✔️	✔️	✔️	✔️
VerifyPassword	✖️	✔️	✖️	✔️

Usage endpoint support

v denoting the API version

name	v1
GetBal	✔️
GetLog	✔️
SendFunds	✔️
VerifyPassword	✔️

Meta endpoints

name	purpose	json input	path	HTTP Method	correct status	return type	return value	Jresp	Jreq	A	U
ChangePassword	to change the password of of Authenticated user	{"pass":string}	api/v1/user/change_password	`PATCH`	204	`N/A`	`N/A`	✔️	✔️	✖️	✔️
AdminChangePassword	to change the password of a given user `{name}`	{"name":string,"pass":string}	api/v1/admin/user/change_password	`PATCH`	204	`N/A`	`N/A`	✔️	✖️	✔️	✖️

Meta endpoint errors

name	400	401	404	406
ChangePassword	✔️	✔️	✖️	✔️
AdminChangePassword	✔️	✔️	✖️	:heavy_check_mark

Meta endpoint support

name	v1
ChangePassword	✔️
AdminChangePassword	✔️

5.9 KiB Raw Blame History