diff --git a/api.md b/api.md index 8672f67..d70068e 100644 --- a/api.md +++ b/api.md @@ -1,7 +1,7 @@ # WiFi Pineapple Module API ## Introduction -Unlike the old web interface, the back end of the new interface has been decoupled from the front end. All requests to perform system actions are sent as POSTs to `/api/`. The content of the POST is JSON and contains a minimal of two parameters. +Unlike the old web interface, the back end of the new interface has been decoupled from the front end. All requests to perform system actions are sent as POSTs to `/api/`. The content of the POST is JSON and contains a minimum of two parameters. #### The first parameter key must be either `system` or `module` `system` is used for core system functions such as logging users in and performing system setup as well as managing notifications. `module` is used when sending a request to any of the default modules or to any user modules. The value is set to the module with which you are trying to communicate. For example, `"system": "notifications"` or `"module": "RandomRoll"`. #### The second parameter key `action`