Protocols/WebAPI/Auth/Client/clientLogin - Revision history

AD: AD moved page Protocols/WebAPI/Auth/clientLogin to Protocols/WebAPI/Auth/Client/clientLogin without leaving a redirect

2020-03-25T22:54:21Z

AD moved page Protocols/WebAPI/Auth/clientLogin to Protocols/WebAPI/Auth/Client/clientLogin without leaving a redirect

← Older revision		Revision as of 22:54, 25 March 2020
(No difference)

AD at 22:45, 25 March 2020

2020-03-25T22:45:39Z

← Older revision		Revision as of 22:45, 25 March 2020
Line 186:		Line 186:
	[[Category:AIM]]		[[Category:AIM]]
	[[Category:Protocols/WebAPI]]		[[Category:Protocols/WebAPI]]
			[[Category:Protocols/WebAPI/Auth]]
			[[Category:Protocols/WebAPI/Auth/Client]]
	[[Category:Work_In_Progress]]		[[Category:Work_In_Progress]]

AD at 22:43, 25 March 2020

2020-03-25T22:43:40Z

← Older revision		Revision as of 22:43, 25 March 2020
Line 1:		Line 1:
	{{Protocols/WebAPI}}		{{Protocols/WebAPI}}

	This page is about the clientLogin method for [[Protocols/WebAPI/Auth\|WebAPI ~~authentication~~]].		This page is about the clientLogin method for [[Protocols/WebAPI/Auth/Client\|WebAPI Client]] authentication.

	== Initial Request ==		== Initial Request ==

AD at 18:08, 25 March 2020

2020-03-25T18:08:57Z

← Older revision		Revision as of 18:08, 25 March 2020
Line 10:		Line 10:

	* HTTP Method		* HTTP Method
	** POST ~~<br />~~ ('''NOTE''': All request parameters must passed in the POST body only, and not in the query string)		** POST ('''NOTE''' : All request parameters must passed in the POST body only, and not in the query string)

	* HTTP Header		* HTTP Header
Line 20:		Line 20:
	*** your developer Id required to access NINA APIs		*** your developer Id required to access NINA APIs
	** f (required)		** f (required)
	*** the required format of the response (~~json~~ or ~~xml or qs~~)		*** the required format of the response (XML, JSON, or the query string)
	** s (required)		** s (required)
	*** the loginID of the source user		*** the loginID of the source user
Line 57:		Line 57:
	== Response Format ==		== Response Format ==

	The following data elements would be returned in the response		The following data elements would be returned in the response.

	* token -- upon successful autentication		* token -- upon successful autentication
Line 71:		Line 71:
	=== The XML standard wrapper ===		=== The XML standard wrapper ===
	<pre>		<pre>
	<response>		<response>
	<statusCode />		<statusCode />
	<statusText />		<statusText />
	<statusDetailCode />		<statusDetailCode />
	<requestId />		<requestId />
	<data>		<data>
	....		....
	</data>		</data>
	</response>		</response>
	</pre>		</pre>

	=== The JSON standard wrapper ===		=== The JSON standard wrapper ===
	<pre>		<pre>
	{"response":{		{"response":{
	"statusCode":""		"statusCode":""
	"statusText":"",		"statusText":"",
	"statusDetailCode":""		"statusDetailCode":""
	"requestId":""		"requestId":""
	"data":{		"data":{
	....		....
	}		}
	}}		}}
	</pre>		</pre>

	=== Query String ===		=== Query String ===

	The following parameters will be returned back as name-value string in URL Query String format (name=value&name=value&...)		The following parameters will be returned back as name-value string in URL Query String format (name=value&name=value&...):

	* statusCode		* statusCode
Line 145:		Line 145:

	=== Sample Response ===		=== Sample Response ===

	==== XML ====		==== XML ====
	<pre>		<pre>
Line 160:		Line 159:
	</data>		</data>
	</response>		</response>
	</pre>		</pre>

	==== JSON ====		==== JSON ====
Line 173:		Line 172:
	"expiresIn":86400,		"expiresIn":86400,
	"a":"%2FwEAAAAAEil22m......"		"a":"%2FwEAAAAAEil22m......"

	}		}
	}		}
Line 181:		Line 179:
	==== Query String ====		==== Query String ====
	<pre>		<pre>
	statusCode=200&statusText=OK&token_a=.....&token_expiresIn=86400&sessionSecret=....&hostTime=1204563933		statusCode=200&statusText=OK&token_a=.....&token_expiresIn=86400&sessionSecret=....&hostTime=1204563933
	</pre>		</pre>

AD: /* JSON */

2020-03-25T16:41:47Z

JSON

← Older revision		Revision as of 16:41, 25 March 2020
Line 164:		Line 164:
	==== JSON ====		==== JSON ====
	<pre>		<pre>
	{"response":{		{"response":{
	"statusCode":200		"statusCode":200
	"statusText":"OK",		"statusText":"OK",
	"data":{		"data":{
	"sessionSecret":"GaPSXTfpvXILlNn6",		"sessionSecret":"GaPSXTfpvXILlNn6",
	"hostTime":1204563933,		"hostTime":1204563933,
	"token":{		"token":{
	"expiresIn":86400,		"expiresIn":86400,
	"a":"%2FwEAAAAAEil22m......"		"a":"%2FwEAAAAAEil22m......"
	}
	}		}
	}}		}
			}}
	</pre>		</pre>

AD: /* XML */

2020-03-25T16:41:36Z

XML

← Older revision		Revision as of 16:41, 25 March 2020
Line 148:		Line 148:
	==== XML ====		==== XML ====
	<pre>		<pre>
	<response xmlns="https://api.login.nina.bz">		<response xmlns="https://api.login.nina.bz">
	<statusCode>200</statusCode>		<statusCode>200</statusCode>
	<statusText>OK</statusText>		<statusText>OK</statusText>
	<data>		<data>
	<token>		<token>
	<expiresIn>86400</expiresIn>		<expiresIn>86400</expiresIn>
	<a>2F......</a>		<a>%2FwEAAAAAZ%2F......</a>
	</token>		</token>
	<sessionSecret>AEqD4Tn4FwOwBMV7</sessionSecret>		<sessionSecret>AEqD4Tn4FwOwBMV7</sessionSecret>
	<hostTime>1204563923</hostTime>		<hostTime>1204563923</hostTime>
	</data>		</data>
	</response>		</response>
	</pre>		</pre>

AD at 16:39, 25 March 2020

2020-03-25T16:39:28Z

@@ Line 93: / Line 93: @@
+          }
      }}
 </pre>

AD at 16:31, 25 March 2020

2020-03-25T16:31:58Z

← Older revision		Revision as of 16:31, 25 March 2020
Line 69:		Line 69:
	* hostTime -- OpenAuth Server current time in seconds since epoch format. Clients can use this to sync their clocks when making other NINA Open Service's calls with "ts" (timestamp) parameter.		* hostTime -- OpenAuth Server current time in seconds since epoch format. Clients can use this to sync their clocks when making other NINA Open Service's calls with "ts" (timestamp) parameter.

			=== The XML standard wrapper ===
			<pre>
			<response>
			<statusCode />
			<statusText />
			<statusDetailCode />
			<requestId />
			<data>
			....
			</data>
			</response>
			</pre>

			=== The JSON standard wrapper ===
			<pre>
			{"response":{
			"statusCode":""
			"statusText":"",
			"statusDetailCode":""
			"requestId":""
			"data":{
			....
			}
			}}
			</pre>

	[[Category:Stub]]		[[Category:Stub]]

AD at 16:30, 25 March 2020

2020-03-25T16:30:02Z

← Older revision		Revision as of 16:30, 25 March 2020
Line 59:		Line 59:
	The following data elements would be returned in the response		The following data elements would be returned in the response

	~~: :~~* token -- upon successful autentication		* token -- upon successful autentication
	:** expiresIn -- Expiry time in secs		** expiresIn -- Expiry time in secs
	:** a - Authentication Token that can be used to invoke other services		** a - Authentication Token that can be used to invoke other services
	:* challenge -- when additional challenges are required to complete authentication		* challenge -- when additional challenges are required to complete authentication
	:** info (optional) -- ASQ Question in case of ASQ Challenge or Image url in case of Captcha challenge		** info (optional) -- ASQ Question in case of ASQ Challenge or Image url in case of Captcha challenge
	:** context -- Authentication context to be returned on subsquent challenge responses		** context -- Authentication context to be returned on subsquent challenge responses
	:* rlToken -- Rate Limit token returned when user successful validates Captcha word and provides valid login credentials (loginId & password)		* rlToken -- Rate Limit token returned when user successful validates Captcha word and provides valid login credentials (loginId & password)
	:* sessionSecret -- Session Secret used to generate a Session Key used for signing subsequent NINA/AIM Open Services requests (WebAIM).		* sessionSecret -- Session Secret used to generate a Session Key used for signing subsequent NINA/AIM Open Services requests (WebAIM).
	:* hostTime -- OpenAuth Server current time in seconds since epoch format. Clients can use this to sync their clocks when making other NINA Open Service's calls with "ts" (timestamp) parameter.		* hostTime -- OpenAuth Server current time in seconds since epoch format. Clients can use this to sync their clocks when making other NINA Open Service's calls with "ts" (timestamp) parameter.

AD at 16:29, 25 March 2020

2020-03-25T16:29:11Z

← Older revision		Revision as of 16:29, 25 March 2020
Line 55:		Line 55:
	*** An optional version of the Client		*** An optional version of the Client

			== Response Format ==

			The following data elements would be returned in the response

			: :* token -- upon successful autentication
			:** expiresIn -- Expiry time in secs
			:** a - Authentication Token that can be used to invoke other services
			:* challenge -- when additional challenges are required to complete authentication
			:** info (optional) -- ASQ Question in case of ASQ Challenge or Image url in case of Captcha challenge
			:** context -- Authentication context to be returned on subsquent challenge responses
			:* rlToken -- Rate Limit token returned when user successful validates Captcha word and provides valid login credentials (loginId & password)
			:* sessionSecret -- Session Secret used to generate a Session Key used for signing subsequent NINA/AIM Open Services requests (WebAIM).
			:* hostTime -- OpenAuth Server current time in seconds since epoch format. Clients can use this to sync their clocks when making other NINA Open Service's calls with "ts" (timestamp) parameter.