Latest revision as of 15:38, 5 January 2018

Sensaphone.net API

The Login API will be used to log in to the Sensaphone.net system. When a user logs in with their username and password they will be assigned a session UUID. The session UUID will have a corresponding time stamp and a timed expiration for their session. The session UUID and statically assigned Account ID will be used as the primary identifier instead of including a username and password in subsequent URI requests.

Example Call

   https://rest.sensaphone.net/api/v1/login/{USERNAME}/{PASSWORD}

Values

• Username
• Password
• Session UUID
• Session Time stamp
• Session Expiration

Example Requests

GET

URI Mode Request URI's:

• Receive Login information

   GET  https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login

• Receive a Login timestamp for a session

   GET https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login/login_timestamp

• Receive the number of seconds until a session expires

   GET https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login/session_expiration 

JSON MODE Request URI:

• Receive Login information

   POST  https://rest.sensaphone.net/api/v1/login

Example JSON

Log in with a username and password using JSON mode.

• Request JSON:

{
 "request_type":"create",
 "resource": "login",
 "user_name": "myusername",
 "password": "pass123"
}

• Response JSON:

{
 "result": {
  "success": true,
  "code": 0,
  "message": "Success"
 },
 "response": {
  "acctid": 987654,
  "session": "0123-4567-8901",
  "login_timestamp": 1499459402,
  "session_expiration": 86400,
  "user_id": 00000001
 }

}

Receive Login information for a given session UUID.

• Request JSON:

{
 "request_type:"read",
 "resource":"login",
 "acctid":987654,
 "session":"0123-4567-8901",
 "login":null
}

• Response JSON:

{
 "result":
  {
   "success: true,
   "code": 0,
   "message":"OK",
  },
  "response":
    {
     "login_timestamp":"2014-12-31 23:59:59",
     "session_expiration":60
    }
 }

PUT

PUT will be used only to update a Login session.

URI Mode Request URI:

• Request to update a Login session

  PUT  https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login

JSON Mode Request URI:

  POST  https://rest.sensaphone.net/api/v1/login

* There may be an instance where the system needs to create a new Session ID and/or Account ID. In which case, it will be outputted in the PUT response.

POST

URI Mode Request URI:

• Request for creating a new login session

 POST https://rest.sensaphone.net/api/v1/login/{USERNAME}/{PASSWORD}

JSON Mode Request URI:

 POST https://rest.sensaphone.net/api/v1/login

DELETE

Deleting a login session is the equivalent to logging out.

URI Mode Request URI:

• Request to log out of a session

 DELETE https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login

JSON Mode Request URI:

 POST https://rest.sensaphone.net/api/v1/login

Future

In the future the login process will support OAuth for advanced access and authentication.

Password Reset

To reset a pass for a particular email, use the following request:

 POST https://rest.sensaphone.net/api/v1/login/reset_password/{email_address}