راهنمای جامع و مستندات استفاده از REST API در ادتو
در مقالات گذشته، ما به بررسی مفاهیم اولیهی وبسرویسها پرداختیم. همچنین با ویژگیهای کلی سیستم ادتو آشنا شدیم. اکنون در این مقاله، به بررسی تخصصی مستندات استفاده از REST API در ادتو میپردازیم. این مستندات به شما کمک میکنند تا تعاملی هوشمند با سامانه داشته باشید. توسعهدهندگان میتوانند با این ابزار، تصاویر امنیتی و تبلیغاتی را به سادگی مدیریت کنند. 🚀
چرا استفاده از REST API در ادتو اهمیت دارد؟
امروزه امنیت وبسایتها بدون سیستمهای اعتبارسنجی دقیق، با خطرات جدی روبرو است. استفاده از REST API در ادتو به شما این امکان را میدهد که علاوه بر امنیت، درآمدزایی کنید. این سرویس به گونهای طراحی شده که پیادهسازی آن در تمامی پلتفرمها امکانپذیر باشد. بنابراین، شما میتوانید به راحتی وبسایت خود را به این سامانه متصل نمایید. 🛡️
مزایای استفاده از وبسرویس ادتو
استفاده از این تکنولوژی مزایای متعددی برای مدیران سایتها و برنامهنویسان دارد. در ادامه به مهمترین آنها اشاره میکنیم:
- ✅ امنیت بسیار بالا: جلوگیری از نفوذ رباتهای مخرب به فرمهای سایت.
- ✅ پاسخگویی سریع: استفاده از معماری REST باعث سرعت بالای انتقال داده میشود.
- ✅ درآمدزایی هوشمند: نمایش تبلیغات در قالب تصاویر امنیتی به کاربران.
- ✅ سادگی در پیادهسازی: مستندات شفاف برای استفاده در تمامی زبانهای برنامهنویسی.
- ✅ ساختار JSON: دریافت پاسخها در قالب استاندارد و خوانا برای سیستمها.
پیشنیازهای شروع کار با API ادتو
برای شروع کار با سامانه، ابتدا باید در سیستم عضو شوید. پس از معرفی خود به عنوان نمایشدهنده، سیستم دو کلید اختصاصی به شما میدهد. این کلیدها برای برقراری ارتباط امن بین سرور شما و ادتو ضروری هستند.
۱. کلید نمایشدهنده (Publisher Key)
شما برای درخواست ایجاد هر تصویر امنیتی به این کلید نیاز دارید. این کد اختصاصی، هویت شما را در سیستم ادتو تایید میکند. در حقیقت، سیستم از این طریق متوجه میشود که درخواست از سمت کدام رسانه ارسال شده است. 🔑
۲. کلید رمز (Secret Key)
این کلید جهت اعتبارسنجی نهایی پاسخ کاربران استفاده میشود. امنیت این کلید بسیار حیاتی است. شما باید این کد را فقط در بخش Backend سایت خود نگهداری کنید. هرگز نباید کاربران یا مرورگرها به این کلید دسترسی داشته باشند. در نتیجه، امنیت سیستم شما حفظ خواهد شد. 🔐
مراحل ثبتنام و دریافت کلیدها
برای استفاده از خدمات و مشاهده مستندات استفاده از REST API در ادتو، مراحل زیر را طی کنید:
- 🌐 به وبسایت اصلی مراجعه نمایید.
- 📝 وارد لینک ثبتنام به آدرس
p.api.irشوید. - 👤 اطلاعات کاربری و مشخصات رسانه خود را ثبت کنید.
- 📥 پس از تایید، کلیدهای Publisher Key و Secret Key را دریافت نمایید.
نحوه کارکرد کلی و فنی سیستم
ساختار تعامل با این سرویس بسیار ساده و منطقی طراحی شده است. ابتدا شما باید درخواست خود را با متد POST به آدرس API ارسال کنید. سپس سیستم یک پاسخ در قالب JSON برای شما ارسال میکند. این پاسخ حاوی اطلاعات لازم برای نمایش تصویر امنیتی به کاربر است. در مرحله بعد، شما باید پاسخ وارد شده توسط کاربر را مجدداً برای ما بفرستید. 🛠️
درخواست ایجاد تصویر امنیتی
در این بخش، پارامترهای دریافتی از سرور را بررسی میکنیم. این جدول راهنمای شما برای مدیریت دادهها خواهد بود:
| نام پارامتر | توضیحات عملکرد |
|---|---|
| 🔹 status | وضعیت درخواست را نشان میدهد (success یا failed). |
| 🔹 message | در صورت بروز خطا، متن پیام خطا در اینجا قرار میگیرد. |
| 🔹 adImage | نام فایل تصویر تبلیغاتی که کاربر در ابتدا مشاهده میکند. |
| 🔹 adImageAddress | آدرس کامل و مستقیم تصویر تبلیغاتی جهت نمایش. |
| 🔹 captchaImage | نام اصلی تصویر امنیتی (کپچا). |
| 🔹 captchaImageAddress | آدرس مستقیم و قابل دسترسی تصویر امنیتی. |
| 🔹 hash | یک رشته متنی طولانی برای امنیت و رهگیری درخواست. |
| 🔹 publisherKey | کلید نمایشدهنده شما که مجدداً بازگردانده میشود. |
| 🔹 lang | زبان درخواستی شما برای تصویر امنیتی. |
| 🔹 customId | شناسه اختصاصی که خودتان برای رهگیری ارسال کردهاید. |
اعتبارسنجی کاربر و حروف وارد شده
پس از اینکه کاربر حروف تصویر را وارد کرد، نوبت به بررسی صحت آن میرسد. شما باید دادهها را به نقطه پایانی (Endpoint) زیر ارسال کنید:
- URL:
https://api.adeto.ir/v1/verify - Method:
POST - Response Type:
JSON
در پاسخ دریافتی، یک مقدار به نام status وجود دارد. اگر این مقدار true باشد، یعنی کاربر به درستی حروف را وارد کرده است. اما اگر false باشد، حروف وارد شده معتبر نیستند. بنابراین، شما باید از کاربر بخواهید مجدداً تلاش کند. 🔄
نکته بسیار مهم: هر تصویر امنیتی تولید شده فقط برای ۳ دقیقه معتبر است. پس از گذشت این زمان، تصویر منقضی (Expire) میشود. در این صورت، شما باید یک درخواست جدید برای تولید تصویر ارسال کنید.
کاربردهای REST API در پروژه های مختلف
استفاده از REST API در ادتو محدود به وبسایتها نیست. شما میتوانید در اپلیکیشنهای موبایل نیز از این سرویس بهره ببرید. همچنین در سیستمهای مدیریت محتوا مثل وردپرس، این API بسیار کارآمد است. با این روش، نرخ اسپم در سایت شما به شکل چشمگیری کاهش مییابد. 📈
نتیجهگیری و اقدام
در این مقاله، تمامی جزئیات مستندات استفاده از REST API در ادتو را بررسی کردیم. آموختیم که چگونه با کلیدهای اختصاصی، امنیت و درآمد را با هم ترکیب کنیم. این سیستم نه تنها جلوی باتها را میگیرد، بلکه تجربه کاربری مناسبی نیز ارائه میدهد. 💡
همین حالا برای ارتقای امنیت و شروع کسب درآمد، در پنل ادتو عضو شوید. اگر سوالی در مورد پیادهسازی فنی دارید، در بخش نظرات با ما در میان بگذارید. متخصصان ما آماده راهنمایی شما هستند.