Developer Information

Query Example

This example uses the fake API key, AFAFAFAFAFAFAFAFAFAFAFAFAFAFAFAF. You will need to replace this with your own API key to use this service. Click here to get your own API key.

Here is an example of how to query us about a openid. Let's say you want to find out if http://example.myopenid.com/ has successfully filled out our CAPTCHA. All you have to do is make an HTTP get request to the following URL:

http://botbouncer.com/api/info?openid=http%3A%2F%2Fexample.myopenid.com%2F&api_key=AFAFAFAFAFAFAFAFAFAFAFAFAFAFAFAF
The reponse will always be text/plain and if your query is well-formed the HTTP Status Code should be 200. If http://example.myopenid.com/ has filled out our CAPTCHA, you'll get a response back that looks this:
verified:true
If http://example.myopenid.com/ has NOT filled out our CAPTCHA, you'll get a response back that looks this:
verified:false
Any malformed request will receive a response with a status code of 400 and a plain text description of how you might remedy the error.

User Redirect

In the event that the user hasn't filled out our CAPTCHA, you'll probably want to send them over to us so they can prove they are not a robot. To do this you will need to pick a URL on your site for us to send the user back to once they've completed (or not) our CAPTCHA.

Let's say you want us to send the user back to the following URL:

http://example.com/captcha_return
then all you have to do is redirect the user to the following URL
http://botbouncer.com/captcha/queryuser?openid=http%3A%2F%2Fexample.myopenid.com%2F&return_to=http%3A%2F%2Fexample.com%2Fcaptcha_return
and once the user has finished, we'll send the user back to you.