Caleb Gardner
117 lines
2.3 KiB
Markdown
117 lines
2.3 KiB
Markdown
# Darkstorm Backend
|
|
|
|
This is a purposefully "simple" application backend made specifically for _my_ apps. It's purpose is to collect minimal (only what's absolutely necessary) amounts of data while still fulfilling all my needs. I've found that other, off the shelf options such as Firebase are a bit heavy on the data collection. Plus I like to make things :P.
|
|
|
|
## DB Structure
|
|
|
|
### API Key
|
|
|
|
```json
|
|
{
|
|
appName: "app name",
|
|
key: "API Key",
|
|
death: -1, // unix timestamp when the key is no longer valid. -1 means there is not expected expiration (that can change in the future)
|
|
perm: {
|
|
user: true, // create and login users
|
|
log: true, // log users
|
|
crash: true, // crash reports
|
|
// further permissions can be added as needed
|
|
}
|
|
}
|
|
```
|
|
|
|
### User
|
|
|
|
```json
|
|
{
|
|
id: "UUID",
|
|
username: "username",
|
|
password: "hashed password",
|
|
salt: "password salt",
|
|
passwordChange: 0, // unix timestamp of last password change
|
|
}
|
|
```
|
|
|
|
## Standard Header
|
|
|
|
Any request might or might not need these values. These values can be authenticated via the `TODO` function.
|
|
|
|
```json
|
|
{
|
|
X-API-Key: "{API Key}",
|
|
Authorization: "Bearer {JWT Token}"
|
|
}
|
|
```
|
|
|
|
## Error Response
|
|
|
|
If an error status code is returned then the body will be as follows.
|
|
|
|
```json
|
|
{
|
|
errorCode: "Error value for internal use",
|
|
errorMsg: "User error message", //This message is meant to be displayed to the user. May be empty.
|
|
}
|
|
```
|
|
|
|
## Users
|
|
|
|
> TODO: Add the ability to create users and log-in through third-parties (such as Google).
|
|
|
|
All requsests pertaining to users requires the `X-API-Key` header and the key must have the `users` permission.
|
|
|
|
### Create User
|
|
|
|
> TODO: Email user to confirm.
|
|
> TODO: Screen username for offensive words and phrases.
|
|
|
|
Request:
|
|
|
|
```json
|
|
{
|
|
username: "Username",
|
|
password: "Password",
|
|
email: "Email",
|
|
}
|
|
```
|
|
|
|
Return:
|
|
|
|
```json
|
|
{
|
|
username: "Username",
|
|
token: "JWT Token"
|
|
}
|
|
```
|
|
|
|
If returned status is 401, the errorCode will be one of the following:
|
|
|
|
* username
|
|
* Username is already taken
|
|
* password
|
|
* Password does not follow rules
|
|
* email
|
|
* Email is already linked to an account
|
|
* disallowed
|
|
* Username contains words/phases that are not allowed
|
|
|
|
### Login
|
|
|
|
Request:
|
|
|
|
```json
|
|
{
|
|
username: "Username",
|
|
password: "Password",
|
|
}
|
|
```
|
|
|
|
Return:
|
|
|
|
```json
|
|
{
|
|
token: "JWT Token",
|
|
timeout: 0, // login attempt timeout (in seconds). If non-zero, token will be empty.
|
|
}
|
|
```
|