API Documentation

API Documentation

To work with this api you mostly will use the /api/:api_id endpoint. This endpoint is the one that will send you a notification when it receives a request.

Postman

View on postman - https://documenter.getpostman.com/view/10616927/Tz5p6y9A

The different endpoints

Route	Method	Parameters	Description
/auth/login	POST	{ 'username': '', 'password': '', 'notificationId': '' }	Login to the application
/auth/register	POST	{ 'username': '', 'password': '' }	Create an account on the instance of the back-end.
/user/check	GET		Check if the current token is valid.
/user/get_api	GET		Get your api Id to send requests to.
/user/get_notifications	GET		Get all of the notifications your account is tied to
/user/get_notification/:id	GET		Get a of the notifications your account is tied to
/user/get_code	GET		Get the user supplied source code
/user/set_code	POST	{ 'code': '' }	Set the user supplied source code
/user/change_username	POST	{ 'username': '' }	Change your username to the one provided in the form
/user/change_password	POST	{ 'password': '' }	Change your password to the one provided in the form
/api/:api_id	GET		The request that has to be done by the target to get notified
/api/:api_id	POST		The request that has to be done by the target to get notified
/api/:api_id	PUT		The request that has to be done by the target to get notified
/api/:api_id	DELETE		The request that has to be done by the target to get notified
/api/:api_id/pic	GET		The request will redirect to a 1px picture
/api/:api_id/code	GET		The request will redirect to user supplied code