expand/CCash
1
0
Fork 0
mirror of https://github.com/Expand-sys/CCash synced 2025-12-17 00:22:14 +11:00
Code Issues Projects Releases Packages Wiki Activity Actions

📚🚧 working on endpoints

Browse source
This commit is contained in:
EntireTwix 2021-07-05 00:45:13 -07:00
parent 6eb02a8288
commit 2d464df178
1 changed files with 27 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
docs/connected_services/how_to/endpoints.md
View file

@ -0,0 +1,27 @@
name
path
admin cert flag
user cert flag
v1
description
returns
# 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](https://en.wikipedia.org/wiki/Basic_access_authentication) 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](https://en.wikipedia.org/wiki/Basic_access_authentication) in the header `Authorization`. This credential must be a valid user, failing to do so results in `401`
:heavy_check_mark:
:heavy_multiplication_x:
### 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` | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: | JSON uint32 | the user's balance | :heavy_check_mark: |