mirror of
https://github.com/Expand-sys/CCash
synced 2025-12-17 00:22:14 +11:00
62 lines
6.3 KiB
Markdown
62 lines
6.3 KiB
Markdown
# API endpoints
|
|
[PREVIOUS PAGE](APIs.md) | [NEXT PAGE](../existing_services.md)
|
|
|
|
## 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](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 error `401`
|
|
|
|
`A` - Admin, same as `U` but in addition requires username supplied be equal to the admin account username
|
|
|
|
:heavy_check_mark:
|
|
:heavy_multiplication_x:
|
|
|
|
## 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 | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_multiplication_x: |
|
|
| 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}] | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_check_mark: |
|
|
| 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 | :heavy_check_mark: | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark: |
|
|
| 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` | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_check_mark: |
|
|
|
|
### Usage enpoint errors
|
|
| name | 400 | 401 | 404 | 406 |
|
|
| :------------- | :----------------------: | :----------------------: | :----------------------: | :----------------: |
|
|
| GetBal | :heavy_multiplication_x: | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_check_mark: |
|
|
| GetLog | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
|
| SendFunds | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
|
| VerifyPassword | :heavy_multiplication_x: | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark: |
|
|
|
|
### Usage endpoint support
|
|
`v` denoting the API version
|
|
| name | v1 |
|
|
| :------------- | :----------------: |
|
|
| GetBal | :heavy_check_mark: |
|
|
| GetLog | :heavy_check_mark: |
|
|
| SendFunds | :heavy_check_mark: |
|
|
| VerifyPassword | :heavy_check_mark: |
|
|
|
|
### Meta endpoints
|
|
| name | purpose | json input | path | HTTP Method | correct status | return type | return value | Jresp | Jreq | A | U |
|
|
| :------------------ | --------------------------------------------- | ------------------------------- | --------------------------------- | :---------: | :------------: | :---------: | :----------: | :----------------: | :----------------: | :----------------------: | :----------------------: |
|
|
| ChangePassword | changes the password of of Authenticated user | {"pass":string} | api/v1/user/change_password | `PATCH` | 204 | `N/A` | `N/A` | :heavy_check_mark: | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark: |
|
|
| AdminChangePassword | changes the password of a given user `{name}` | {"name":string,"pass":string} | api/v1/admin/user/change_password | `PATCH` | 204 | `N/A` | `N/A` | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_multiplication_x: |
|
|
| SetBal | sets the balance of a give users `{name}` | {"name":string,"amount":uint32} | api/v1/admin/set_balance | `PATCH` | 204 | `N/A` | `N/A` | :heavy_check_mark: | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark: |
|
|
|
|
### Meta endpoint errors
|
|
| name | 400 | 401 | 404 | 406 |
|
|
| :------------------ | :----------------: | :----------------: | :----------------------: | :----------------: |
|
|
| ChangePassword | :heavy_check_mark: | :heavy_check_mark: | :heavy_multiplication_x: | :heavy_check_mark: |
|
|
| AdminChangePassword | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
|
| SetBal | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
|
|
|
|
### Meta endpoint support
|
|
| name | v1 |
|
|
| :------------------ | :----------------: |
|
|
| ChangePassword | :heavy_check_mark: |
|
|
| AdminChangePassword | :heavy_check_mark: |
|
|
| SetBal | :heavy_check_mark: |
|