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

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

2020-03-25T22:53:52Z

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

2020-03-25T22:53:42Z

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

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

	This method can be used to obtain a Captcha Image or Audio file for a given authentication context. The Captcha Image or Audio files are generally required to challenge the user upon receiving a Captcha Challenge from "directLogin" method.		This method can be used to obtain a Captcha Image or Audio file for a given authentication context. The Captcha Image or Audio files are generally required to challenge the user upon receiving a Captcha Challenge from "directLogin" method.
Line 39:		Line 39:
	[[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]]

2020-03-25T18:16:06Z

← Older revision		Revision as of 18:16, 25 March 2020
Line 26:		Line 26:

	== Response Format ==		== Response Format ==

	Response will be either image or audio content based on the requested format. Standard HTTP status codes will be used to indicate errors.		Response will be either image or audio content based on the requested format. Standard HTTP status codes will be used to indicate errors.
			* HTTP Response Codes
	~~'''~~HTTP Response Codes~~'''~~		* 200 - Success (OK)
	* 200 - Success (Ok)
	* 302 - Redirect to SSL		* 302 - Redirect to SSL
	* 400 - Bad Request (invalid context)		* 400 - Bad Request (invalid context)

2020-03-25T16:58:43Z

← Older revision		Revision as of 16:58, 25 March 2020
Line 25:		Line 25:
	*** Authentication Context returned in previous directLogin request when additional challenges are required		*** Authentication Context returned in previous directLogin request when additional challenges are required

			== Response Format ==

			Response will be either image or audio content based on the requested format. Standard HTTP status codes will be used to indicate errors.

			'''HTTP Response Codes'''
			* 200 - Success (Ok)
			* 302 - Redirect to SSL
			* 400 - Bad Request (invalid context)
			* 415 - Unsupported Media Type
			* 500 - Internal Server Error
			* 503 - Service Unavailable

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

2020-03-25T16:57:37Z

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

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

			This method can be used to obtain a Captcha Image or Audio file for a given authentication context. The Captcha Image or Audio files are generally required to challenge the user upon receiving a Captcha Challenge from "directLogin" method.

			== Initial Request ==

			* URL
			** https://api.screenname.nina.bz/auth/getCaptcha
			** NOTE: Supported on SSL (https) only
			* HTTP Method
			** GET
			* Arguments
			** devId (required)
			*** your developer id required to access NINA APIs
			** f (optional)
			*** the required format of the response
			*** Supported formats:
			**** image (Content-Type: image/jpeg) (default)
			**** audio (Content-Type: audio/mpeg)
			** language (optional)
			*** the required language and locale of the error/status messages. This is always in "<lang>-<locale>" format. The lang is the 2 letter language code for I18N (default: en) and the locale is the 2 letter Locale code for I18N (default: us). If not passed in, the language will be extracted from HTTP header (Accept-Language) and if that is not available will default to "en-us".
			** context (required)
			*** Authentication Context returned in previous directLogin request when additional challenges are required

2020-03-25T15:59:16Z

New page

{{Protocols/WebAPI}}

[[Category:Stub]]
[[Category:AOL]]
[[Category:AIM]]
[[Category:Protocols/WebAPI]]
[[Category:Work_In_Progress]]