Difference between revisions of "Protocols/WebAPI/Auth/Client/getCaptcha"
Jump to navigation
Jump to search
(Created page with "{{Protocols/WebAPI}} Category:Stub Category:AOL Category:AIM Category:Protocols/WebAPI Category:Work_In_Progress") |
|||
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 | ||
Revision as of 16:57, 25 March 2020
WebAPI Protocol |
Basic |
Introduction |
Clients |
Whimsicals |
Host Interaction |
Flow |
Authentication |
• Client |
• WebApp |
Other Services |
• |
Foodgroups |
This page is about the getCaptcha method for 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
- devId (required)