Create CAPTCHA challenge

From ePrize Developers Wiki

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
-
{{Logo}}
+
{{RESTfulAPI
-
<pre>Request representation: empty
+
|crumbs=[[API Home Page]] :: [[CAPTCHA]]
 +
|summary=Create a CATPCHA challenge for the user to complete. Some [[API Key|API keys]] will require a CAPTCHA challenge to be solved before a profile can be created. The created CATPCHA challenge must be [[Fetch_CAPTCHA_challenge|fetched]] and displayed to the user, and then the user's answer provided during [[Create_profile|profile creation]].
 +
|resource=/v1/{apikey}/captcha
 +
|methods=POST
 +
|resourceargs='''apikey''': Your [[API Key]]
 +
|paramsrequired=None.
-
Response:
+
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.
-
201 Created
+
}}
-
Location: /v1/{apikey}/captcha/{challenge-id}
+
-
<?xml version="1.0" encoding="UTF-8" ?>
+
{{RESTfulExample
 +
|title=Create a CAPTCHA Challenge
 +
|request=Request representation: empty
 +
|responsecode=201 Created
 +
|responseloc=Location: /v1/{apikey}/captcha/{challenge-id}
 +
|response=<?xml version="1.0" encoding="UTF-8" ?>
<result>1</result>
<result>1</result>
 +
}}
-
 
+
{{RESTfulExample
-
Response if CAPTCHA can not be created:
+
|title=Response if CAPTCHA can not be created
-
503 Service Unavailable
+
|request=Request representation: empty
-
</pre>
+
|responsecode=503 Service Unavailable
-
 
+
|response=<?xml version="1.0" encoding="UTF-8" ?>
-
 
+
<result />
-
Note: some user have had difficulty with empty POST requests. Adding a random name/value pair (foo=foo) to the request representation can avoid this problem.
+
}}

Revision as of 20:15, 7 April 2011

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 />


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