mirror of
https://github.com/exzork/GCAuth.git
synced 2024-11-24 00:23:58 +00:00
update readme
This commit is contained in:
parent
bb27c8f2bd
commit
7cadc86ac0
15
README.md
15
README.md
@ -7,9 +7,18 @@ Grasscutter Authentication System
|
|||||||
- All payload must be send with `application/json` and Compact JSON format ( without unnecessary spaces )
|
- All payload must be send with `application/json` and Compact JSON format ( without unnecessary spaces )
|
||||||
- Auth endpoint is:
|
- Auth endpoint is:
|
||||||
- Check auth status : `/grasscutter/auth_status` (GET)
|
- Check auth status : `/grasscutter/auth_status` (GET)
|
||||||
- Register: `/grasscutter/register` (POST) <br>payload : `{"username":"username","password":"password","password_confirmation":"password_confirmation"}`
|
- Register: `/grasscutter/register` (POST)
|
||||||
- Login: `/grasscutter/login` (POST) <br>payload : `{"username":"username","password":"password"}`
|
```
|
||||||
- Change password: `/grasscutter/change_password` (POST) <br>payload : `{"username":"username","new_password":"new_password","new_password_confirmation":"new_password_confirmation","old_password":"old_password"}`
|
{"username":"username","password":"password","password_confirmation":"password_confirmation"}
|
||||||
|
```
|
||||||
|
- Login: `/grasscutter/login` (POST)
|
||||||
|
```
|
||||||
|
{"username":"username","password":"password"}
|
||||||
|
```
|
||||||
|
- Change password: `/grasscutter/change_password` (POST)
|
||||||
|
```
|
||||||
|
{"username":"username","new_password":"new_password","new_password_confirmation":"new_password_confirmation","old_password":"old_password"}
|
||||||
|
```
|
||||||
- Response is `JSON` with following keys:
|
- Response is `JSON` with following keys:
|
||||||
- `status` : `success` or `error`
|
- `status` : `success` or `error`
|
||||||
- `message` : `success` or `error` message :
|
- `message` : `success` or `error` message :
|
||||||
|
Loading…
Reference in New Issue
Block a user