Why and when use this API?
- This API is useful for help you in detecting humans and machines. You can use it in your forms at your site.
How to use this API:
- You are force to sign up at this site and get your personal key to use our services.
If you have not signed up yet you can return to main page and select Sign up option from services list.
You should send your key to this API address.
We support GET and POST methods.
API address:
- http://howdiw.ir/api/captcha/
Posted parameters:
- key : your personal key
An example for GET method:
- http://howdiw.ir/api/captcha/?key=1234abcd
Outputs:
- ok : It may be "true" for successful procces or "false" for failure procces
- img_address : If true, returns captcha image address
- captcha : If true, returns captcha text
- description : If false, returns the cause of fail
Descriptions:
- The link of captcha image will inactive after 20 seconds
For VIP users:
- Users have VIP subscription can use these services:
- Choice the lengh of captcha with "len" parameter
example: len=7
minimum is 1 and maximum is 10
- Choice ideal captcha with "captcha" parameter
example: captcha=54fd1s
English letters and English numbers are just allowed
- Choice existence of big or small English letters or numbers with "big" and "small" and "number" parameters
example: big=true or small=false or number=false
In default mode big English letters and numbers are choicen
این وبسرویس چه کاربردی دارد؟
- از این وبسرویس میتوان برای تولید کپچا جهت جداسازی انسان از ماشین برای استفاده از بخش خاصی از سایت خود ( مثل ارسال فرم ها ) استفاده کرد.
روش استفاده از وب سرویس:
- برای استفاده از این وبسرویس باید ثبتنام کرده باشید و کلید اختصاصی خود را دریافت کرده باشید.
اگر ثبتنام نکردید به صفحه اول برگردید و از لیست خدمات گزینه ثبتنام را انختاب کنید.
برای استفاده میبایست کلید خود را به آدرس وبسرویس ارسال کنید.
ما از متد های GET و POST پشتیبانی میکنیم.
آدرس وبسرویس:
- http://howdiw.ir/api/captcha/
پارامترهای ارسالی:
- key : کلید اختصاصی شما
مثالی برای متد GET:
- http://howdiw.ir/api/captcha/?key=1234abcd
خروجی ها:
- ok : دو حالت true و false دارد که true به معنی موفقیت آمیز بودن عملیات و false به معنی وجود خطا در عملیات است
- img_address : در صورت true بودن آدرس عکس کپچای رندوم را دربرمیگیرد
- captcha : در صورت true بودن متن کپچای رندوم را دربرمیگیرد
- description : در صورت false بودن نوع خطا را دربرمیگیرد
توضیحات:
- لینک عکس کپچا بعد از 20 ثانیه غیرفعال میشود
مخصوص کاربران ویژه:
- افرادی که اشتراک ویژه دریافت میکنند میتوانند امکانات زیر را دریافت کنند:
- انتخاب تعداد حروف کپچا با پارامتر len
مثال: len=7
حداقل طول len برابر 1 و حداکثر طول len برابر 10 میباشد
- انتخاب کپچای دلخواه خود با پارامتر captcha
مثال: captcha=54fd1s
فقط حروف انگلیسی و اعداد مجاز هستند
- انتخاب وجود حروف بزرگ یا کوچک انگلیسی یا اعداد در کپچا با پارامترهای big و small و number
مثال: big=true یا small=false یا number=false
در حالت پیشفرض حروف بزرگ انگلیسی و اعداد در کپچا استفاده میشوند