Sensaphone.net API/login - Revision history

Mwood: /* Sensaphone.net API */ Update Session data type.

2025-07-10T15:28:03Z

‎Sensaphone.net API: Update Session data type.

Derek: /* Example Call */

2018-01-05T20:38:02Z

‎Example Call

Derek: /* DELETE */

2017-10-10T19:11:26Z

‎DELETE

Derek at 20:49, 7 September 2017

2017-09-07T20:49:32Z

Derek at 20:40, 7 July 2017

2017-07-07T20:40:34Z

Tim: /* Sensaphone.net API */

2015-04-30T15:53:20Z

‎Sensaphone.net API

Tim: Created page with "=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 sessi..."

2015-04-29T18:16:25Z

Created page with "=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 sessi..."

New page

=[[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://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

{{TableStart|border_size=1
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''
}}{{TableRowN| acctid | Required | Integer | Static ID of user
}}{{TableRowN| session | Required | Integer | Session ID of user
}}{{TableEnd}}
<br>
{{TableStart|border_size=1
}}{{TableRowN| '''Response Property''' | '''Included''' | '''Type''' | '''Description'''
}}{{TableRowN| login_timestamp | Optional | String | Time stamp of last log in
}}{{TableRowN| session_expiration | Optional | Integer | Seconds until log in expiration
}}{{TableRowN| user_id | Optional | Integer | ID of the logged in user
}}{{TableEnd}}

====Example JSON====
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

{{TableStart|border_size=1
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''
}}{{TableRowN| acctid | Required | Integer | Static ID of user
}}{{TableRowN| session | Required | Integer | Session ID of user
}}{{TableRowN| user_name | Optional | String | Username
}}{{TableRowN| password | Optional | String | Password for username
}}{{TableEnd}}
<br>
{{TableStart|border_size=1
}}{{TableRowN| '''Response Property''' | '''Included''' | '''Type''' | '''Description'''
}}{{TableRowN| acctid | Conditionally* | Integer | Static ID of user
}}{{TableRowN| session | Conditionally* | Integer | Session ID of user
}}{{TableRowN| login_timestamp | Always | Integer | Time stamp of renewed session
}}{{TableRowN| session_expiration | Always | Integer | Time until new log in session expiration
}}{{TableRowN| user_id | Always | Integer | ID of the logged in user
}}{{TableEnd}}
<nowiki>*</nowiki> 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

{{TableStart|border_size=1
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''
}}{{TableRowN| user_name | Required | String | Username
}}{{TableRowN| password | Required | String | Password for username
}}{{TableEnd}}
<br>
{{TableStart|border_size=1
}}{{TableRowN| '''Response Property''' | '''Type''' | '''Description'''
}}{{TableRowN| acctid | Integer | Static ID of user
}}{{TableRowN| session | Integer | Session ID of user
}}{{TableRowN| login_timestamp | Integer | Time stamp of renewed session
}}{{TableRowN| session_expiration | Integer | Time until new log in expiration
}}{{TableRowN| user_id | Integer | ID of the logged in user
}}{{TableEnd}}

===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/login/{ACCTID}/{SESSION}
'''JSON Mode Request URI:'''
'''POST''' https://rest.sensaphone.net/api/v1/login

{{TableStart|border_size=1
}}{{TableRowN| '''Request Property''' | '''Status''' | '''Type''' | '''Description'''
}}{{TableRowN| acctid | Required | Integer | Static ID of user
}}{{TableRowN| session | Required | Integer | Session ID of user
}}{{TableEnd}}

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

@@ Line 44: / Line 44: @@
 *'''Request JSON:'''
+  {
-   "request_type:"create",
+   "request_type":"create",
    "resource": "login",
    "user_name": "myusername",

← Older revision		Revision as of 20:40, 7 July 2017
Line 41:		Line 41:

	====Example JSON====		====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.		Receive Login information for a given session UUID.

← Older revision		Revision as of 15:53, 30 April 2015
Line 133:		Line 133:
	==Future==		==Future==
	In the future the login process will support OAuth for advanced access and authentication.		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}

@@ Line 30: / Line 30: @@
 }}{{TableRowN| '''Request Property'''  | '''Status''' | '''Type''' | '''Description'''
 }}{{TableRowN| acctid                       | Required     | Integer    | Static ID of user
-}}{{TableRowN| session                         | Required     | Integer    | Session ID of user
+}}{{TableRowN| session                         | Required     | String    | Session ID of user
 }}{{TableEnd}}
 <br>
@@ Line 104: / Line 104: @@
 }}{{TableRowN| '''Request Property'''  | '''Status''' | '''Type''' | '''Description'''
 }}{{TableRowN| acctid                  | Required     | Integer    | Static ID of user
-}}{{TableRowN| session                    | Required     | Integer    | Session ID of user
+}}{{TableRowN| session                 | Required     | String     | Session ID of user
 }}{{TableRowN| user_name               | Optional     | String     | Username
 }}{{TableRowN| password                | Optional     | String     | Password for username
@@ Line 110: / Line 110: @@
 <br>
 {{TableStart|border_size=1
-}}{{TableRowN| '''Response Property''' | '''Included''' | '''Type''' | '''Description'''
+}}{{TableRowN| '''Response Property''' | '''Included'''  | '''Type''' | '''Description'''
 }}{{TableRowN| acctid                  | Conditionally*  | Integer    | Static ID of user
-}}{{TableRowN| session                    | Conditionally*  | Integer    | Session ID of user
+}}{{TableRowN| session                 | Conditionally*  | String     | Session ID of user
-}}{{TableRowN| login_timestamp         | Always         | Integer    | Time stamp of renewed session
+}}{{TableRowN| login_timestamp         | Always          | Integer    | Time stamp of renewed session
-}}{{TableRowN| session_expiration      | Always         | Integer    | Time until new log in session expiration
+}}{{TableRowN| session_expiration      | Always          | Integer    | Time until new log in session expiration
-}}{{TableRowN| user_id              | Always     | Integer    | ID of the logged in user
+}}{{TableRowN| user_id                 | Always          | Integer    | ID of the logged in user
 }}{{TableEnd}}
 <nowiki>*</nowiki> 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.
@@ Line 135: / Line 135: @@
 }}{{TableRowN| '''Response Property''' | '''Type''' | '''Description'''
 }}{{TableRowN| acctid                  | Integer    | Static ID of user
-}}{{TableRowN| session                    | Integer    | Session ID of user
+}}{{TableRowN| session                 | String     | Session ID of user
 }}{{TableRowN| login_timestamp         | Integer    | Time stamp of renewed session
 }}{{TableRowN| session_expiration      | Integer    | Time until new log in expiration
-}}{{TableRowN| user_id               | Integer    | ID of the logged in user
+}}{{TableRowN| user_id                 | Integer    | ID of the logged in user
 }}{{TableEnd}}
@@ Line 153: / Line 153: @@
 }}{{TableRowN| '''Request Property'''  | '''Status''' | '''Type''' | '''Description'''
 }}{{TableRowN| acctid                  | Required     | Integer    | Static ID of user
-}}{{TableRowN| session                    | Required     | Integer    | Session ID of user
+}}{{TableRowN| session                 | Required     | String     | Session ID of user
 }}{{TableEnd}}

@@ Line 4: / Line 4: @@
 ==Example Call==
-     https://sensaphone.net/api/v1/login/{USERNAME}/{PASSWORD}
+     https://rest.sensaphone.net/api/v1/login/{USERNAME}/{PASSWORD}
 ==Values==

@@ Line 146: / Line 146: @@
 '''URI Mode Request URI:'''
 *Request to log out of a session
-   '''DELETE''' https://rest.sensaphone.net/api/v1/login/{ACCTID}/{SESSION}
+   '''DELETE''' https://rest.sensaphone.net/api/v1/{ACCTID}/{SESSION}/login
 '''JSON Mode Request URI:'''
    '''POST''' https://rest.sensaphone.net/api/v1/login