این بخش برای توسعه دهندگان و وب مسترهایی تهیه شده است که تمایل دارند از api کوتاه کننده لینک و متن لای در وبسایت یا وبلاگ خود استفاده کنند و بدین وسیله به کاربران و بازدیدکنندگان وبسایت خود این امکان را بدهند تا بدون نیاز به مراجعه به سایت لای ، لینک ها یا متن های خود را کوتاه کنند.
API کوتاه کننده لینک لای:
کلیه درخواست ها باید به آدرس http://api.lye.ir/get یا http://api.lye.ir/post ارسال شوند. ارسال درخواست از طریق هر دو متد POST و GET امکان پذیر می باشد
http://api.lye.ir/get
http://api.lye.ir/post
هر چند که استفاده از متد POST به توسعه دهندگان توصیه می گردد.
به عنوان مثال درخواست زیر با استفاده از متد GET انجام می پذیرد :
http://api.lye.ir/get?url=https://www.google.com/&custom=gol
در درخواست فوق ، آدرس http://google.com به عنوان لینک بلند و کلمه gol به عنوان آدرس custom ارسال شده است.
و
در هر درخواست شما باید پارامترهای ورودی را همراه با درخواست ارسال کنید و پس از پردازش درخواست ، خروجی را مطابق با فرمتی که درخواست نموده اید ، دریافت خواهید کرد.
ورودی هر درخواست شامل یک پارامتر اجباری و تعدادی پارامتر اختیاری خواهد بود که در زیر به بررسی آن ها خواهیم پرداخت.
پارامترهای ورودی :
url :( اجباری ) : تنها پارامتر اجباری برای ارسال یک درخواست است که باید حاوی URL مورد نظر شما جهت کوتاه شدن باشد. در صورتی که مقدار ارسال شده یک آدرس معتبر اینترنتی نباشد ، سرویس ما یک پیغام خطا تولید خواهد کرد و آدرس وارد شده کوتاه نخواهد شد.
نکته مهم : تمامی URL هایی که ارسال می شوند باید encode شده باشند. اکثر زبان های برنامه نویسی برای encode کردن آدرس های اینترنتی ، توابعی را در نظر گرفته اند . مثلا در جاوااسکرپیت می توانید از تابع encodeURIComponent برای این موضوع استفاده کنید. در زبان های سمت سرور مثل PHP نیز توابعی نظیر rawurlencode برای این موضوع تدارک دیده شده اند. برای اطلاعات بیشتر به http://www.w3schools.com/tags/ref_urlencode.asp مراجعه نمایید.
custom: ( اختیاری ) : پارامتری اختیاری است که امکان انتخاب آدرس کوتاه شده را به کاربر می دهد . آدرس انتخابی باید بین 3تا 64 کاراکتر بوده و شامل کاراکترهای غیر مجازی نباشد ( کاراکترهای مجاز شامل حروف کوچک الفبای انگلیسی و ارقام 0 تا 9 هستند ). همچنین آدرس انتخابی نباید قبلا استفاده شده باشد. در صورتی که آدرس انتخابی تکراری باشد ، سیستم ایجاد پیغام خطا خواهد کرد و کاربر می تواند آدرس دیگری را انتخاب نماید.
type: ( اختیاری ) :نوع پیش فرض آن json است و حالت های json یا xml دارد
private: ( اختیاری ): تنظیم نشانی خصوصی (بدون هیچ لیستی).
password: ( اختیاری ):تنظیم رمز و میزان آن حداکثر تا ده کارکتر میباشد
uses: ( اختیاری ):بعد از این تعداد بازدید لینک ساخته شده شما بصورت خودکار حذف میشود و حداکثر تعداد آن 100 هزار میباشد
expire: ( اختیاری ): تاریخ با فرمت MM/DD/YYYY برای حذف خودکار لینک ثبت شده شما (تاریخ انقضا)
via: ( اختیاری ) : امضا برنامه شما میباشد برای مثال (api)
مثال:
http://api.lye.ir/get?url=http://google.com&custom=gol&type=xml
لینک های ثبت شده با درخواست بالا بصورت زیر میباشند
www.Lye.ir/gol
www.CO0.ir/gol
www.gol.lye.ir
www.gol.CO0.ir
که کد خروجی مساوی است با:
نمونه کدhtml
API کوتاه کننده متن لای:
در قسمت کوتاه کننده متن همه چیز شبیه کوتاه کننده لینک میباشد تنها فرقی که دارد بجای
url که در قسمت کوتاه کننده لینک اجباری بود در قسمت کوتاه کننده متن
matn تنها پارامتر اجباری میباشد و بقیه پارامترها اختیاری هستند
با اینکه سایت لای هر دو روش GET , POST را برای برنامه نویسان عزیز طراحی کرده هست ولی توصیه میگردد حتما از متد POST استفاده کنید تا متن شما بدون هیچ گونه تغیری در سایت ثبت گردد
کلیه درخواست ها باید به آدرس http://api.lye.ir/matn/get یا http://api.lye.ir/matn/post ارسال شوند. ارسال درخواست از طریق هر دو متد POST و GET امکان پذیر می باشد
http://api.lye.ir/matn/get
http://api.lye.ir/matn/post
هر چند که استفاده از متد POST به توسعه دهندگان توصیه می گردد.
به عنوان مثال درخواست زیر با استفاده از متد GET انجام می پذیرد :
http://api.lye.ir/matn/get?matn=test.matn.baraye.kotahsazi&custom=testmatn
در درخواست فوق ،متن test.matn.baraye.kotahsazi به عنوان matn و کلمه testmatn به عنوان آدرس custom ارسال شده است.
در هر درخواست شما باید پارامترهای ورودی را همراه با درخواست ارسال کنید و پس از پردازش درخواست ، خروجی را مطابق با فرمتی که درخواست نموده اید ، دریافت خواهید کرد.
ورودی هر درخواست شامل یک پارامتر اجباری و تعدادی پارامتر اختیاری خواهد بود که در زیر به بررسی آن ها خواهیم پرداخت.
پارامترهای ورودی :
matn :( اجباری ) : تنها پارامتر اجباری برای ارسال یک درخواست است که باید حاوی URL مورد نظر شما جهت کوتاه شدن باشد. در صورتی که مقدار ارسال شده یک آدرس معتبر اینترنتی نباشد ، سرویس ما یک پیغام خطا تولید خواهد کرد و آدرس وارد شده کوتاه نخواهد شد.
نکته مهم : تمامی URL هایی که ارسال می شوند باید encode شده باشند. اکثر زبان های برنامه نویسی برای encode کردن آدرس های اینترنتی ، توابعی را در نظر گرفته اند . مثلا در جاوااسکرپیت می توانید از تابع encodeURIComponent برای این موضوع استفاده کنید. در زبان های سمت سرور مثل PHP نیز توابعی نظیر rawurlencode برای این موضوع تدارک دیده شده اند. برای اطلاعات بیشتر به http://www.w3schools.com/tags/ref_urlencode.asp مراجعه نمایید.
custom: ( اختیاری ) : پارامتری اختیاری است که امکان انتخاب آدرس کوتاه شده را به کاربر می دهد . آدرس انتخابی باید بین 3تا 64 کاراکتر بوده و شامل کاراکترهای غیر مجازی نباشد ( کاراکترهای مجاز شامل حروف کوچک الفبای انگلیسی و ارقام 0 تا 9 هستند ). همچنین آدرس انتخابی نباید قبلا استفاده شده باشد. در صورتی که آدرس انتخابی تکراری باشد ، سیستم ایجاد پیغام خطا خواهد کرد و کاربر می تواند آدرس دیگری را انتخاب نماید.
type: ( اختیاری ) :نوع پیش فرض آن json است و حالت های json یا xml دارد
private: ( اختیاری ): تنظیم نشانی خصوصی (بدون هیچ لیستی).
password: ( اختیاری ):تنظیم رمز و میزان آن حداکثر تا ده کارکتر میباشد
uses: ( اختیاری ):بعد از این تعداد بازدید لینک ساخته شده شما بصورت خودکار حذف میشود و حداکثر تعداد آن 100 هزار میباشد
expire: ( اختیاری ): تاریخ با فرمت MM/DD/YYYY برای حذف خودکار لینک ثبت شده شما (تاریخ انقضا)
via: ( اختیاری ) : امضا برنامه شما میباشد برای مثال (api)
مثال:
http://api.lye.ir/matn/get?matn=test.matn.baraye.kotahsazi&custom=tmatn&type=xml
لینک های ثبت شده با درخواست بالا بصورت زیر میباشند
www.Lye.ir/tmatn
www.CO0.ir/tmatn
www.tmatn.lye.ir
www.tmatn.CO0.ir
که کد خروجی مساوی است با:
نمونه کد html