Skip to content

Latest commit

 

History

History
84 lines (66 loc) · 4.07 KB

Discovery.md

File metadata and controls

84 lines (66 loc) · 4.07 KB
Raw
title tagline theme_color git homepage
HDBVM
Easy Human Distinction By Visual Method API, in short - CAPTCHA API
#2980b9

HDBVM

HDBVM


It stands for `Human Distinction By Visual Medthod`, in other words, a `captcha` api.
Go To API Dashboard

What HDBVM can do?

  • Create captcha images.
    • Randomly generated
    • Randomly generated but given length
    • Given value
  • Store captcha images temporarily(15 minutes).
  • Verify generated captcha with given input.

API Docs

Make a CAPTCHA image

You can make a captcha image without making a completely functional captcha, just the image. To do so you have a few options.

Random Image

Just use - /api/img. This gets a random captcha every time, 4 characters long.

Random Image from given length

Just use - /api/img/length/<length>. This gets a random captcha every time, with given amount of characters.

Image from given value

Just use - /api/img/value/<value>. This gets a captcha with given value. The image might be different each time however.

Image from existing captcha

Just use - /api/img/id/<id>. This gets the exact same captcha unless captcha was renewed or captcha was succesfully passed. This just fetches one if it exists. To make one you need to create a captcha.

Make a CAPTCHA

To make a captcha, call the url - /api/new. This will return you a JSON with content including ID of the captcha.

{
	"id": <captcha id here>
}

Randomly Generated CAPTCHA

To generate a random captcha, nothing extra is required in the url - /api/new. This returns a captcha with 4 characters.

Randomly Generated CAPTCHA given the length

To generate a random captcha with given amount of characters, just add length property - /api/new/length/<length>.

CAPTCHA from given value

To generate a captcha with given value, just add value property - /api/new/value/<value>.

Match CAPTCHA with value

To match values you need to have id of a captcha and a value you want to check. Then use - /api/check/<id>/<value> to get a JSON with data. If id captcha is expired/invalid, result will always be false.

{
	"id": <id>,
	"exists": <if the id is valid - true>,
	"result": <if the value is correct - true>
}

Renew a CAPTCHA

A captcha can be renewed if it has not expired. However from this, image will always change. The value might be changed if wanted. The id for the captcha can be used for 15 minutes more. Both cases will return a similar JSON. Result will only bee true if captcha is valid and the process was successful.

{
	"id": <captcha id here>,
	"result": <if captcha was renewed - true>
}

Renew the value and image

To renew both captcha and image, use - /api/renew/<id>.

Renew the image only

To renew the captcha image only, use - /api/renew/img/<id>.

Our icon

To get our icon, if you wish so, use /icon.

HDBVM