2023-08-05 23:28:57 +01:00
|
|
|
# Burgernotes API docs
|
|
|
|
|
Use the Burgernotes API to automate tasks, build your own client, and more!
|
|
|
|
|
|
2023-08-06 18:17:28 +01:00
|
|
|
Headers should be: "Content-type: application/json; charset=UTF-8" for all POSTs
|
|
|
|
|
|
2023-08-05 23:28:57 +01:00
|
|
|
## Authentication
|
|
|
|
|
|
|
|
|
|
POST - /api/signup - provide "username" and "password".
|
|
|
|
|
|
|
|
|
|
POST - /api/login - provide "username" and "password".
|
|
|
|
|
|
|
|
|
|
To prevent the server from knowing the encryption key, password you provide in the request must be hashed with the argon2 algorithm.
|
2023-08-05 23:54:44 +01:00
|
|
|
The salt should be the SHA-512 of the password.
|
2023-08-05 23:28:57 +01:00
|
|
|
|
|
|
|
|
Password must be at least 14 characters, username must be under 20 characters and alphanumeric.
|
|
|
|
|
|
|
|
|
|
If username is taken, error code 422 will return.
|
|
|
|
|
|
|
|
|
|
Assuming everything went correctly, the server will return a secret key.
|
|
|
|
|
|
|
|
|
|
You'll need to store two things in local storage:
|
|
|
|
|
- The secret key you just got, used to fetch notes, save stuff etc.
|
|
|
|
|
- SHA512 hashed password, used as encryption key
|
|
|
|
|
|
|
|
|
|
## Encryption
|
|
|
|
|
|
|
|
|
|
Note content and title is encrypted using AES 256-bit.
|
|
|
|
|
|
|
|
|
|
Encryption password is the SHA512 hashed password we talked about earlier.
|
|
|
|
|
|
|
|
|
|
## Basic stuff
|
|
|
|
|
|
|
|
|
|
POST - /api/userinfo - get user info such as username, provide "secretKey"
|
|
|
|
|
|
|
|
|
|
POST - /api/listnotes - list notes, provide "secretKey"
|
|
|
|
|
note titles will have to be decrypted.
|
|
|
|
|
|
|
|
|
|
POST - /api/newnote - create a note, provide "secretKey" and "noteName"
|
|
|
|
|
"noteName" should be encrypted.
|
|
|
|
|
|
|
|
|
|
POST - /api/readnote - read notes, provide "secretKey" and "noteId"
|
|
|
|
|
note content will have to be decrypted.
|
|
|
|
|
|
|
|
|
|
POST - /api/editnote - edit notes, provide "secretKey", "noteId", and "content"
|
|
|
|
|
"content" should be encrypted.
|
|
|
|
|
|
|
|
|
|
POST - /api/removenote - remove notes, provide "secretKey" and "noteId"
|
|
|
|
|
|
|
|
|
|
## More stuff
|
|
|
|
|
|
|
|
|
|
POST - /api/deleteaccount - delete account, provide "secretKey"
|
|
|
|
|
please display a warning before this action
|
|
|
|
|
|
|
|
|
|
POST - /api/exportnotes - export notes, provide "secretKey"
|
|
|
|
|
note content and title will have to be decrypted
|
