Create CAPTCHA challenge

From ePrize Developers Wiki

Revision as of 20:15, 7 April 2011 by Wikiadmin (Talk | contribs)
Jump to: navigation, search

API Home Page :: CAPTCHA

Summary

Create a CATPCHA challenge for the user to complete. Some API keys will require a CAPTCHA challenge to be solved before a profile can be created. The created CATPCHA challenge must be fetched and displayed to the user, and then the user's answer provided during profile creation.

Resource

/v1/{apikey}/captcha

Valid Methods

POST

Resource Arguments

Note: resource arguments are always required.

apikey: Your API Key

Parameters Required

None.

Note: some users have had difficulty with empty POST requests. Adding a random name/value pair (foo=foo) to the request representation can avoid this problem.



Example: Create a CAPTCHA Challenge

Request

Request representation: empty

Response

HTTP Status Code: 201 Created

HTTP Redirect Location: Location: /v1/{apikey}/captcha/{challenge-id}

<?xml version="1.0" encoding="UTF-8" ?>
<result>1</result>


Example: Response if CAPTCHA can not be created

Request

Request representation: empty

Response

HTTP Status Code: 503 Service Unavailable


<?xml version="1.0" encoding="UTF-8" ?>
<result />


Personal tools