REST API built using NodeJS for Cabal Online.
- Register an account
- Credentials validation and JWT generation
- Validating JWT
- Character listing and info
- Latest stable version of NodeJS installed.
- Cabal Online MSSQL database running.
- Clone or download the project to a directory.
- Run
npm install
to install code dependencies. - Create
development.json
orproduction.json
insideconfig
folder depending upon your server environment to override default config options if needed. - Run
npm start
to start the API server.
Endpoint | Method | Description | Params | JWT Required |
---|---|---|---|---|
/ | GET | API version and name | - | No |
/account/me | GET | Validate token | - | Yes |
/account/register | POST | Register an account | username, password, email | No |
/account/login | POST | Receive JWT | username, password | No |
/character | GET | Character list | - | Yes |
/character/:id | GET | Character info | - | Yes |
JWT token has to be sent in Authorization
header with Bearer
prefix for all routes where JWT is required.
The following are the clients available for the API