مستندات استفاده از REST API در ادتو

shape
shape
shape
shape
shape
shape
shape
shape

در مقاله های قبل در مورد آشنایی با وب سرویس ادتو و وب سرویس ادتو توضیح دادیم در این مقاله در مورد مستندات استفاده از REST API در ادتو توضیح خواهیم داد

شروع

برای شروع کار با سامانه اول نیاز دارید تا در سیستم ثبت نام کنید و پس از معرفی خودتون به عنوان نمایش‌دهنده، سیستم به شما یک کلید نمایش‌دهنده (Publisher Key) و یک کلید رمز (Secret Key) اختصاص میده که با استفاده از اون می‌تونید با API ارتباط برقرار کنید(مستندات استفاده از REST API در ادتو).

کلید نمایش‌دهنده (Publisher Key)

جهت درخواست ایجاد تصویر امنیتی شما می‌بایست از کلید نمایش‌دهنده که سیستم براتون اختصاص داده استفاده بکنید.

کلید رمز (Secret Key)

جهت اعتبارسنجی پاسخ کاربران باید از کلید رمز که سیستم براتون اختصاص داده استفاده بکنید. دقت کنید که این کلید می‌بایست به صورت ایمن از سمت شما به API ارسال بشه (در backend) و کاربران شما نباید از این کلید با اطلاع باشند.

نحوه کارکرد کلی

نحوه کلی کارکرد به اینصورت هست که برای ایجاد تصویر امنیتی شما باید درخواستتون رو با استفاده از متود POST به آدرس API ما ارسال کنید. بعد در پاسخ که به صورت JSON هست شما مقادیر لازم رو برای نمایش یک تصویر امنیتی دریافت خواهید کرد.
برای اعتبارسنجی متن وارد شده توسط کاربر نیاز هست تا شما متنی که کاربر وارد کرده رو به همراه بعضی از مقادیری که ما براتون در هنگام ساخت این تصویر امنیتی ارسال کردیم رو مجدد به سمت ما ارسال کنید.

درخواست ایجاد تصویر امنیتی

مستندات استفاده از REST API در ادتو

responseexplanation table

Parameter                           Description
status                                  if everything goes well in your request, it’s gonna be “success”, otherwise it will be “failed”

message                            if anything goes wrong, you will get the error message here

adImage                            the image name for the add (first image that the user sees before the captcha), just the image name

adImageAddress                 the adImage above with complete and accessible URL

captchaImage                    real captcha image name, just the image name

captchaImageAddress        the captchaImage above with complete and accessible URL
hash                               just a long string that we need, don’t worry about it

publisherKey                    we send back your Publisher Key to you again

lang                                we send back your requested captcha language to you again
customId                         if you have already sent your request with a customId, we send it back here again so you know what you have requested

اعتبارسنجی کاربر و حروف وارد شده

URL: https://api.adeto.ir/v1/verify
Method: POST
Response Type: JSON

مستندات استفاده از REST API در ادتو

مستندات استفاده از REST API در ادتو

در پاسخ دریافتی از سمت سرور در بالا با استفاده از مقدار status که true/false هست می‌تونید اعتبار حروف وارد شده توسط کاربر رو بسنجید. بدیهیه که true به معنی معتبر بودن حروف وارد شده توسط کاربر و false به معنی نامعتبر بودن اون هست.

لازم به ذکر هست که هر تصویر امنیتی تولید شده فقط برای 3 دقیقه معتبر هست و بعد از اون expire میشه.

جهت استفاده از مستندات استفاده از REST API در ادتو به منبع مراجعه نمائید

منبع 

پاسخی بگذارید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *