2022-06-24 23:09:46 +04:00
|
|
|
justcaptcha ver. 1.0
|
|
|
|
|
====================
|
|
|
|
|
|
|
|
|
|
A simple CAPTCHA service implementation.
|
|
|
|
|
|
2022-06-26 21:01:47 +04:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
justcaptchad -expiry 5m -listen /var/run/justcaptchad/j.sock
|
|
|
|
|
|
|
|
|
|
`-expiry` takes time for CAPTCHA to be valid for in format XX{s,m,h}.
|
|
|
|
|
|
|
|
|
|
`-listen` is `ip:port` or `/path/to/unix.sock` to listen on.
|
|
|
|
|
|
2022-06-24 23:09:46 +04:00
|
|
|
## API
|
|
|
|
|
|
|
|
|
|
### Get a new captcha
|
|
|
|
|
|
|
|
|
|
GET /
|
|
|
|
|
|
|
|
|
|
It will return an ID of a new captcha in plaintext.
|
|
|
|
|
|
|
|
|
|
#### HTTP codes
|
|
|
|
|
- 200 if created
|
|
|
|
|
|
|
|
|
|
### Get an image for a captcha
|
|
|
|
|
|
|
|
|
|
GET /:captcha_id/image
|
|
|
|
|
|
|
|
|
|
Responds with an image (e.g. in PNG format).
|
|
|
|
|
|
|
|
|
|
#### HTTP codes
|
|
|
|
|
- 200 if exists
|
|
|
|
|
- 404 if doesn't exist
|
2022-06-26 15:47:15 +04:00
|
|
|
- 500 if for some reason Image wasn't created
|
2022-06-24 23:09:46 +04:00
|
|
|
|
|
|
|
|
### Submit an answer
|
|
|
|
|
|
|
|
|
|
POST /:captcha_id
|
|
|
|
|
|
|
|
|
|
It takes one form-data parameter `answer=123456`.
|
|
|
|
|
|
|
|
|
|
Responds with empty body and one of HTTP codes.
|
|
|
|
|
|
|
|
|
|
#### HTTP codes
|
|
|
|
|
- 200 if solved
|
|
|
|
|
- 403 if not solved
|
|
|
|
|
- 404 if doesn't exist
|
|
|
|
|
|
|
|
|
|
### Check if captcha is solved
|
|
|
|
|
|
|
|
|
|
GET /:captcha_id
|
|
|
|
|
|
|
|
|
|
Responds with empty body and one of HTTP codes.
|
|
|
|
|
|
|
|
|
|
#### HTTP codes
|
|
|
|
|
- 200 if solved
|
|
|
|
|
- 403 if not solved
|
|
|
|
|
- 404 if doesn't exist
|
