README.md

USER ACTIVITIES ENDPOINT

« back to menu

Table of Contents

• user register
• login
• user session
• user update
• logout
• delete

1.1 user register

• URL
  

  https://t-gadgetapi.herokuapp.com/user/register
  

• Request method
  POST

• Params body
  

  PARAMETER	REQUIRED	UNIQUE	TYPE	MIN_LENGTH	MAX_LENGTH
  email	yes	yes	text	8 char	30 char
  username	yes	yes	text	8 char	20 char
  password	yes	no	text	8 char	20 char

• Success response

  • code : 201 Created
    json :

    { 
      "success": true,
      "message": "user register is success" 
    }
    

• Error Response:

  • code : 400 Bad Request
    json : { "success": false,"message": {} }
    
  • code : 500 Internal Server Error
    json : { "success": false,"message": "" }

1.2 login

• URL
  

  https://t-gadgetapi.herokuapp.com/user/login
  

• Request method
  POST

• Params body
  

  PARAMETER	REQUIRED	TYPE
  username	yes	text
  password	yes	text

• Success response

  • code : 200 Ok
    json :

    { 
      "success": true,
      "data": {
          user_id:"",
          api_key:"",
          token:"",
      } 
    }
    

• Error Response:

  • code : 400 Bad request
    json : { "success": false,"message": "" }
    
  • code : 401 Unauthorized
    json : { "success": false,"message": "" }
    
  • code : 500 Internal Server Error
    json : { "success": false,"message": "" }

• Notes:
  token lifetime is 1 hour

1.3 user session

• Request method
  GET
• URL
  

  https://t-gadgetapi.herokuapp.com/user/session
  

• Params header
  • api-key
    
  • token
    
• Success response
  • code : 200 Ok
    json :

    { 
      "success": true,
      "data": {
          user_id:"",
          token_age:"",
      } 
    }
    

• Error Response:
  • code : 401 Unauthorized
    json : { "success": false,"message": "" }
    
  • code : 500 Internal Server Error
    json : { "success": false,"message": "" }

1.4 user update

• URL
  

  https://t-gadgetapi.herokuapp.com/user/edit
  

• Request method
  PUT

• Params header

  • api-key
    
  • token
    

• Params body
  

  PARAMETER	REQUIRED	UNIQUE	TYPE	MIN_LENGTH	MAX_LENGTH
  new_username	yes	yes	text	8 char	20 char
  new_password	yes	yes	text	8 char	20 char

• Success response

  • code : 201 Created
    json :

    { 
      "success": true,
      "message": "edit user is success"
    }
    

• Error Response:

  • code : 400 Bad Request
    json : { "success": false,"message": "" }
    
  • code : 401 Unauthorized
    json : { "success": false,"message": "" }
    
  • code : 500 Internal Server Error
    json : { "success": false,"message": "" }

1.5 logout

• URL
  

  https://t-gadgetapi.herokuapp.com/user/logout
  

• Request method
  DELETE
• Params header
  • api-key
    
  • token
    
• Success response
  • code : 202 Accepted
    json :

    { 
      "success": true,
      "message": "logout success"
    }
    

• Error Response:
  • code : 401 Unauthorized
    json : { "success": false,"message": "" }
    
  • code : 500 Internal Server Error
    json : { "success": false,"message": "" }

1.6 delete

• URL
  

  https://t-gadgetapi.herokuapp.com/user/delete
  

• Request method
  DELETE
• Params header
  • api-key
    
  • token
    
• Success response
  • code : 202 Accepted
    json :

    { 
      "success": true,
      "message": "delete account success"
    }
    

• Error Response:
  • code : 401 Unauthorized
    json : { "success": false,"message": "" }
    
  • code : 500 Internal Server Error
    json : { "success": false,"message": "" }