BotDetect CAPTCHA: The Simple API -- Experimental

BotDetect CAPTCHA Simple API: A Few Things to Note

1. BotDetect CAPTCHA has two APIs:
   The Simple API, and the Traditional API -- use one or another -- never ever mix them!

2. If you are looking for the docs of our old-school Traditional API -- click on the link here -- do not proceed with this page!

3. If you are looking for the docs of our experimental Simple API -- do proceed with this page.

4. BotDetect CAPTCHA is stable, indeed; but with the Simple API -- beware!
   There are reasons why the Simple API has that 'experimental' designation:

   • The Simple API itself is still a work-in-progress -- its specs are not frozen yet.
   • The vast majority of its accompanying docs are simply not up to the task yet.
5. If you run into troubles -- do not be shy to ask for help :)

[back to the top of the page]

..............................................................

Simple API: The Docs You Can Trust

These docs are updated and polished -- and reasonably bug-free at the moment! Make sure that your BotDetect CAPTCHA Simple API integration efforts do start with one of them.

• Angular Captcha: A Step-by-step Integration Guide
• AngularJS Captcha: A Step-by-step Integration Guide
• jQuery Captcha: A Step-by-step Integration Guide
• React Captcha: A Step-by-step Integration Guide

If you find a bug, or would like to suggest a documentation improvement, please let us know.

[back to the top of the page]

..............................................................

Simple API: The Docs You Should Take with a Grain of Salt

In fact, a lot of effort went into making these docs as bug-free as possible.

However, due to the release timings, and the way we packaged the BotDetect archives, there are discrepancies in between the examples shipped and the examples described in the docs bellow.

• Angular Captcha: API Basics Example
• Angular Captcha: Contact Form Example
• AngularJS Captcha: API Basics Example
• AngularJS Captcha: Contact Form Example
• jQuery Captcha: API Basics Example
• jQuery Captcha: Contact Form Example
• React Captcha: API Basics Example
• React Captcha: Contact Form Example

We are changing the packaging; and these examples will converge with the shipped ones over the upcoming minor releases. Until then, double-check everything -- and trust your own common sense!

[back to the top of the page]

..............................................................

Simple API: The Docs That Are Not for the Faint of Heart, Yet

If your integration effort starts with any of the docs below -- we bet it will stray to nowhere!

These docs are neither up to date nor have they ever been polished. While they do contain quite a lot of useful bits -- overall, they are an outdated bug-ridden mess -- do not rely upon them, yet!

But, once you have your Simple API integration, as described in those step-by-step integration guides mentioned above, up and running -- they might be useful for whatever is your next step.

• Simple API: Class Reference
• Simple API: Enumerations Reference
• Simple API: Captcha Options
• Simple API: botdetect.xml File
• Simple API: Session Storage
• Simple API: FAQ

In 2019/04 we finally evicted the last Simple API docs from the Traditional API docs' tabs and dropped them all into their own documentation branch here. The long-overdue packaging and documentation overhaul process started soon after that. Over the upcoming months we will try hard to get them into some semi-decent shape. Until then, well -- welcome to the jungle :)

Bookmark this page and refresh it from time to time to get the situation updates.

[back to the top of the page]