API کوتاه کننده
در این مقاله قصد داریم تا وب سرویس کوتاه کننده لینک ا معرفی کنیم.
ارسال درخواست
ارسال درخواست به سرور با دو متد GET و POST امکانپذیر است!
متد POST
آدرس درگاه (جدید)
https://do0.ir/post/[key]/[ver]/[errorType] (Optional)
آدرس نمونه
https://do0.ir/post/test1324/2.5
نکته: ارسال درخواست به صورت آجاکس بین سرور (Cross Server Ajax) میسر است.
اتصال ایمن: برای ارسال درخواست به سرور می بایست آدرس API با پروتکل https وارد شود!
پارامتر ها (ورودی)
پارامتر key
مقدار این پارامتر “کلید توسعه دهنده (API KEY)” است.
برای دریافت کلید توسعه دهنده پس از ثبت نام در سایت، وارد بخش API شوید و با استفاده از فرم موجود یک API جدید ایجاد کنید و کد خود را به جای api_key قرار دهید.
پارامتر ver
مقدار این پارامتر شماره نسخه فعلی API است.
این شماره از طرف تیم توسعه سایت تعیین می شود و پس از هر بروزرسانی این عدد تغییر می کند.
شماره نسخه فعلی API: 2.5
پارامتر errorType (دلخواه)
این پارامتر نوع پیام خطا را تعیین می کند.
مقادیر قابل قبول:
simple : پیام خطا به صورت ساده و بدون تگ های HTML
code : پیام خطا به صورت کد خطایابی
html : پیام خطا به صورت کد HTML به همراه توضیحات
مقدار این پارامتر به صورت پیشفرض برابر با html خواهد بود. مقدار این پارامتر به حروف کوچک و بزرگ حساس نیست.
پارامتر link (POST)
ورودی/مقدار این پارامتر آدرسی است که می خواهید کوتاه شود.
نکته مهم (رمزگذاری)
قبل از ارسال درخواست توسط متد های گفته شده؛ آدرس ارسالی را رمزگذاری کنید.
رمزگذاری آدرس ها بر اساس زبان برنامه نویسی شما متفاوت است! همچنین مثال هایی از رمزگذاری آدرس ها را می توانید در بخش Samples/Lab مشاهده کنید.
پارامتر ها (خروجی)
- id شناسه لینک
- short لینک کوتاه شده
- address (فشرده) آدرس اولیه لینک
- public وضعیت نمایش (عمومی یا خصوصی بودن)
- success وضعیت عملیات (دو مقدار false و true)
- error خطا (در صورت وجود)
خروجی کلی (صحیح)
{“success”: true,”error”: “”,”id”: …,”address”: …,”short”: …,”public”: …}
خروجی کلی (وجود خطا) ?
{“success”: false,”error”: …}
متد GET (پیشنهاد نمی شود)
آدرس درگاه
https://do0.ir/send.php?rel=api&key=[key]&ver=2.5&type=get&L=[URL] &errorType=[errorType]
API آمارگیر دوصفر
این API در حال حاضر به صورت BETA (آزمایشی) کار می کند و به زودی امکانات گسترده تری به آن اضافه خواهد شد!
همچنین نمونه ای از استفاده این API در بخش Samples موجود است!
آدرس درگاه (کوتاه)
https://do0.ir/stat_api/{LINK_NAME}
آدرس درگاه (بلند)
https://do0.ir/json.php?i={LINK_NAME}&type=stat
پارامتر i مقدار این پارامتر نام لینکی است که میخواهید اطلاعات آماری آن را دریافت کنید…
MINI API (کوتاه کننده کوچک)
یکی از آخرین امکانات دوصفر می باشد که می توانید برای هر API Key یک نسخه کوچک ایجاد کنید!
با استفاده از این امکان برای سایت/وبلاگ خود یک کوتاه کننده اختصاصی و 100% رایگان بسازید! آن هم در سرور های ایران…!!!
آدرس اصلی
https://do0.ir/m/{“MINI_KEY”}/2.5.1
نسخه فعلی (پایدار) 2.5.1
1. ابتدا طبق روش گفته شده در ابتدا همین صفحه برای خودتان یک API Key ایجاد کنید…
2. پس از ایجاد کد افزونه خودتان به بخش API در پنل کاربریتان مراجعه فرمائید.
3. سپس برای دریافت کد مخصوص mini api مانند تصویر زیر روی “دریافت کد mini” کلیک کنید.
MINI_KEY1
4. پس از کلیک روی دریافت کد مشاهده می کنید که به جای کلمه “دریافت کد” یک کلمه تصادفی به شما نمایش داده می شود که آن، درواقع همان مینی کد شماست!
MINI_KEY2
5. در نهایت مینی کد خود را در آدرس بالا جایگذاری کنید و صاحب کوتاه کننده اختصاصی خود شوید!
در این مطلب در مورد معرفی وب سرویس کوتاه کننده توضیح دادیم در مطلب بعدی در مورد نمونه کد php وب سرویس کوتاه کننده لینک دوصفر توضیح خواهیم داد.