API documentation
Authentication
Authenticate user sending two required parameters email and password.
Accepts form-data request body and returns JSON response.
Parameters
email required
password required
curl POST 'http://angulartest.com-beta.com/api/auth/' \
-F 'email=test@test.com' \
-F 'password=test'
Successful Response
{
"status": "success",
"code": 200,
"data": {
"email": "test@test.com",
"token": "awesometoken"
}
}
Failed Response
{
"status": "fail",
"code": 400,
"errors": {
"password": "Incorrect credentials."
}
}
List
Only authenticated users have access to it.
Using GET request method and sending token received after user authentication
via request header will return successful JSON response.
Parameters
page optional, default 1
Defines current page number.
limit optional, default 5
Defines items per page.
curl GET 'http://angulartest.com-beta.com/api/list/' \
-H 'Token: awesometoken'
Successful Response
{
"status": "success",
"code": 200,
"data": {
"items": [],
"pagination": {
"current": 1,
"total": 2,
"limit": 5
}
}
}
Failed Response
{
"status": "fail",
"code": 401,
"errors": {
"auth": "Not valid token provided."
}
}