service-captcha/README.md
Leonid Nikitin 01153867b3
Update README.md.
Fixed link to JavaScript GUI repository.
2023-12-13 23:27:45 +06:00

51 lines
2.1 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## О проекте
Захотелось написать свой независимый сервис защиты от роботов. Сервис каптча написан на фреймворке Laravel. Вдохновлялся, а так же брал картинки с проекта <a href="https://github.com/wenlng/go-captcha" target="_blank">Go Captcha</a>.
## Зависимости
php 8.2 (модули: redis, gd)
redis
mysql 8
## Демострация
Демо сервис каптча: https://captcha-admin-demo.tut-site.net/
Email: demo@tut-site.net
Пароль: demodemo
Демо каптча: https://captcha-demo.tut-site.net/
## API
https://captcha-admin-demo.tut-site.net/api-docs/
## Javascript клиент для сайта
https://git.kor-elf.net/kor-elf/service-captcha-gui
## Как проверять со стороны бэкенда
Для Laravel 10 есть готовый пакет: https://git.kor-elf.net/kor-elf/captcha-rule-for-laravel
Можно установить этот пакет так: composer require kor-elf/captcha-rule-for-laravel
<br><b>Curl:</b>
curl -X POST 'https://captcha-admin-demo.tut-site.net/api/v1/captcha/{captcha-token}' -H 'private-token: {your-private-token}' -H 'Content-Type: application/json' -d '{"user_agent": "{user-agent}"}' --max-time 10
Где {captcha-token} - токен получил пользователь от сервиса каптча после успешной проверки.
Где {your-private-token} - приватный токен, который мы создали в админке.
Где {user-agent} - передаём user agent от пользователя, который проходил каптчу.
Успешная проверка пользователя вернёт ответ код 200 и status = true. Иначе считаем, что пользователь не прошёл проверку на робота.
## Репозиторий с демо
https://git.kor-elf.net/kor-elf/service-captcha-demo
## Лицензия
[MIT license](https://opensource.org/licenses/MIT).