2.1 KiB
API structure
GET vs. POST
Some parts of API accepts both GET and POST type requests. We recommend you to prefer second option, when it's possible, just because it is more private, when used with SSL or Tor. However, authentification and authenticated requests can be performed only with POST.
Naming conventions
Files starting from "_" ("_example.php") are intended for internal use only.
Version 1
-
_config.php: parses configuration file
-
_db.php: connection to database and all related
-
_auth.php: things related to authentification
-
_errors.php: error strings
-
_json.php: wrappers for JSON functions
-
stats.php (GET/POST): all general statistics about this instance
-
admin/ (POST): private statistics about this instance
-
admin/dbview.php (POST): manage databases
-
admin/nukelock.php (POST): emergency "red button" to lock all operations to read-only mode
-
user/ (GET/POST): get user information by id
-
user/list.php (GET/POST): get list of all users
-
user/create.php (POST): create new user account
-
user/edit.php (POST): edit user profile
-
user/delete.php (POST): delete user account
-
post/ (GET/POST): get single post by id
-
post/search.php (GET/POST): get list of posts matching the criteria
-
post/create.php (POST): create new post with image
-
post/edit.php (POST): edit tags of post
-
post/delete.php (POST): delete post
-
post/vote.php (POST): rate the existing post
-
comments/ (GET/POST): show all comments from section by id
-
comments/create.php (POST): create new comment at selected section
-
comments/edit.php (POST): edit existing comment
-
comments/delete.php (POST): remove existing comment