API وب سرویس

بعد از این‌که شما ثبت‌نام کردید، به شما یک کلید اختصاصی API داده می‌شود. این کلید به شما اجازه می‌دهد که به رابط XML وب سرویس دسترسی پیدا کنید. برای آزمایش شما می‌توانید از پیش‌نمایش که از مجموعهٔ کوچکی از سوالات استفاده می‌کند، استفاده کنید.

یک سوال کپچا را می‌توان با استفاده از درخواست GET به آدرس زیر، دریافت کرد:

http://api.textcaptcha.ir/your_api_key

پاسخ XML شامل عناصر question و answer هستند:

  • عنصر question، سوال است که در فرمت plain text است.
  • عناصر answer، تبدیل‌شده‌های جواب‌ها به MD5 هستند.
    <captcha>
      <question>اگر فردا جمعه باشد، امروز چه روزی است؟</question>
      <answer>2cf0a16e46fe60f46860b4a85d8d8267</answer>
      <answer>b2b62f03dd1e10f6c069fc38998bcbf4</answer>
      <answer>32da14ea4ea092878fb3b1209437ff2a</answer>
      <answer>2a6e26fd11c7934fcd8a9c8ef605dc89</answer>
      <answer>bf03b48482f59ea0f3622bb1b55ce750</answer>
      <answer>e6b059b2f172b05ff1b930a75e36e5fd</answer>
    </captcha>

در مثال XML بالا، ۶ جواب ممکن است وجود داشته باشد، «پنج‌شنبه»، «پنج شنبه»، «۵شنبه»، «۵ شنبه»، «5شنبه» و «5 شنبه». تمام جواب‌ها MD5 شده‌اند. توجه کنید که در سیستم‌عامل ویندوز به‌دلیل استفاده نشدن از کیبورد استاندارد فارسی، اعداد به انگلیسی نیز جواب صحیح محسوب می‌شوند. برای این‌که بدانید چگونه این XML را به سوال و جواب در فرم تبدیل کنید، باید بخوانید که چگونه از این سرویس باید استفاده کرد.

محدودیت درخواست

ما به شما توصیه می‌کنیم که برنامهٔ خود را طوری بنویسید که در صورت جواب ندادن API به درخواست شما، از یک مجموعه سوال/جواب محلی که در دیسک ذخیره شده‌است استفاده کنید.