Fetch CAPTCHA challenge

From ePrize Developers Wiki

(Difference between revisions)
Jump to: navigation, search
Current revision (20:32, 7 April 2011) (edit) (undo)
 
(6 intermediate revisions not shown.)
Line 1: Line 1:
-
<pre>Request representation: empty
+
{{RESTfulAPI
 +
|crumbs=[[API Home Page]] :: [[CAPTCHA]]
 +
|summary=Fetch a CAPTCHA challenge to be solved by a user. This request will typically be sent from the user's browser. The CAPTCHA challenge can also be proxied from the application for display.
-
Response:
+
The CAPTCHA challenge secret is embedded in the response in a way that only humans and very smart robots can determine the secret.
-
200 OK
+
|resource=/v1/{apikey}/captcha/{challenge-id}
-
Content-Type: image/png
+
|methods=GET
-
</pre>
+
|resourceargs='''apikey''': Your [[API Key]]
-
The CAPTCHA challenge secret is embedded in the response in a way that only humans can determine the secret.
+
'''challenge-id''': Returned after [[Create_CAPTCHA_challenge|creating a CAPTCHA challenge]]. Typically the Location of the challenge should be used without parsing.
 +
|paramsrequired=None.
 +
}}
-
<pre>Response if CAPTCHA does not exist:
+
== Example ==
-
404 Not Found
+
 
-
</pre>
+
Example CAPTCHA: [[Image:Captcha2.png]]
 +
 
 +
 
 +
{{RESTfulExample
 +
|title=Fetch a CAPTCHA Challenge
 +
|request=Request representation: empty
 +
|responsecode=20O OK
 +
|response=Content-Type: image/png
 +
Content-Length: {size}
 +
 
 +
Binary image data {size} octets in length
 +
}}
 +
 
 +
{{RESTfulExample
 +
|title=Response if CAPTCHA does not exist
 +
|request=Request representation: empty
 +
|responsecode=404 Not Found
 +
|response=None
 +
}}

Current revision

API Home Page :: CAPTCHA

Summary

Fetch a CAPTCHA challenge to be solved by a user. This request will typically be sent from the user's browser. The CAPTCHA challenge can also be proxied from the application for display.

The CAPTCHA challenge secret is embedded in the response in a way that only humans and very smart robots can determine the secret.

Resource

/v1/{apikey}/captcha/{challenge-id}

Valid Methods

GET

Resource Arguments

Note: resource arguments are always required.

apikey: Your API Key

challenge-id: Returned after creating a CAPTCHA challenge. Typically the Location of the challenge should be used without parsing.

Parameters Required

None.



Example

Example CAPTCHA: Image:Captcha2.png


Example: Fetch a CAPTCHA Challenge

Request 

Request representation: empty

Response

HTTP Status Code: 20O OK 


Content-Type: image/png
Content-Length: {size}

Binary image data {size} octets in length


Example: Response if CAPTCHA does not exist

Request 

Request representation: empty

Response

HTTP Status Code: 404 Not Found 


None


Retrieved from "https://code.helloworld.com/wiki/index.php/Fetch_CAPTCHA_challenge"
Personal tools