رابط برنامه کاربردی کوتاه کننده آدرس - URL Shortener API

لذت نهایت دسترسی!

بسیاری از کاربران با کاربرد کوتاه کننده آدرسهای اینترنتی آشنا هستند. آدرسهای کنونی بدلیل استفاده از حروف سایر زبانها ظاهری طولانی به خود گرفته و بخاطر سپاری آنها ممکن نیست. در اینترنت نیز به طرز قارچ گونه ای کوتاه کننده آدرس یافت می شود که بعد از مدتی غیر فعال و یا بسته خواهند شد. اما هدف ما از عنوان این مطلب چیست؟ ما نیز همچون دیگر توسعه دهندگان سرویس کوتاه کننده آدرس های اینترنتی را راه اندازی نمودیم(اوایل 93). این سرویس آدرسها را می گرفت و لینک کوتاه شده ی آنرا برای کاربر نهایی به نمایش می گذاشت. اینبار قصد معرفی ویژگی هایی را داریم تا راحتی کاربرد این سرویس را دو چندان کند.

رابط برنامه کاربردی(API)

قطعا شما طراح وب ، توسعه دهنده و یا هر عنوان دیگر علاقه دارید تا بدون مراجعه به وب سایت اصلی و بسیار سریع نه تنها از این سرویس بلکه از سایر سرویس ها و خدمات دیگر استفاده کنید. سیستم کوتاه کننده URL ما نیز از این روش ، پشتیبانی موثری می کند که به نظرتان می رسانیم.

کوتاه کننده سریع!

بسیار برایتان پیش آمده که بخواهید بعد از اتمام مطلب ، نوشته و یا هر موضوع دیگر یک لینک کوتاه از آن مطلب را نیز برای کاربران به نمایش بگذارید. این API کار شما را بسیار راحت می کند. ابتدا قبل از توضیح مثال زیر را ببینید و راحتی آن را لمس کنید!:

<vtwo data-type="urlshortener" data-key="87075078-9b23-5fc8-8ca9-60d8e6c9e611"></vtwo>
<vtwo data-type="urlshortener" data-style="aqua" data-key="87075078-9b23-5fc8-8ca9-60d8e6c9e611"></vtwo>
<vtwo data-type="urlshortener" data-caption="لینک کوتاه(Short Link)" data-key="87075078-9b23-5fc8-8ca9-60d8e6c9e611"></vtwo>
<!-- در آخر صفحه -->
<script type="text/javascript" src="https://vtwo.org/fa/apis/platform.js"></script>

و نتیجه: 

برای تنظیمات و استفاده چه کنیم؟

استفاده

حالا همه چیز آماده است! وقت آن رسیده تا یک حال اساسی به وب سایت خود بدهید. کافیست کدهای لازم را که در ادامه توضیح داده خواهد شد را برای هر صفحه از وب سایت خود که می خواهید استفاده کنید قرار دهید.

تنظیمات دریافت کلید عمومی و ثبت دامنه

حال بعد از ورود به حساب کاربری ، به بخش "API و وب سرویس" رفته و کلید عمومی خود را دریافت نمایید. در این بخش همچنین باید دامنه های تحت مالکیت خود را معرفی کنید که قرار است این برنامه یا برنامه های ما در آن بکار گرفته شوند.

ایجاد حساب کاربری

ابتدا یک حساب کاربری ایجاد کنید. برای ایجاد حساب فقط نیاز به یک ایمیل معتبر دارید تا حساب خود را تایید کنید.

شروع

برای شروع باید یک حساب کاربری ایجاد کنید. تقریبا یک حساب برای همه چیز. در هر حال پس از ایجاد حساب و ورود به صفحه کاربری خود ، کلیه تنظیمات لازم در دسترس شما خواهد بود. این تنظیمان بسیار ساده و روان هستند. در این صفحه بخشی بعنوان "API و وب سرویس" وجود دارد که شامل اطلاعات و تنظیمات لازم برای برقراری ارتباط با برنامه های کاربردی ما هستند.

بعد از رویت کلید عمومی نیاز دارید تا دامنه یا دامنه های خود را که می خواهید از این سرویس در آنها استفاده کنید را ثبت کنید. بعد از ثبت تقریبا همه چیز حل است و کافیست از کدهای زیر که عملکرد آنها بیان خواهد شد را در هر کجای وب سایت خود بکار ببرید.

پیاده سازی

استقرار جاوا اسکریپت

ابتدا باید کد جاوا اسکریپت زیر را در آخر صفحه وب یا HTML خود قرار دهید. توجه داشته باشید که باید حتما در آخر صفحه و بعد از کلیه کدهای جاوا اسکریپت شما باشد مثلا قبل از بسته شدن تگ <body/>.

محل قرارگیری اسکریپت(کد زیر) در صفحه وب شما حتما رعایت شود.

<!-- در آخر صفحه -->
<script type="text/javascript" src="https://vtwo.org/fa/apis/platform.js"></script>
قرارگیری تگها

تگ وی۲ به فرمت <vtwo></vtwo> است(مانند سایر تگهای html). جهت نمایش درست باید ابتدا نوع درخواست خود را مشخص نمایید:

توجه: در صورت مشخص نکردن کلید ، کاربر به آدرس اصلی وب سایت جهت ادامه درخواست هدایت خواهد شد.

<vtwo data-type="urlshortener"></vtwo>

و بعد باید کلید عمومی که در بالا اشاره کردیم که بعد از ثبت نام یا ورود به سیستم > صفحه کاربری > بخش "API و وب سرویس" دریافت کنید. سپس کد زیر را با کلید عمومی مخصوص خود در هر کجای صفحه یا وب سایت خود که مایل بودید قرار دهید. توجه داشته باشید که جهت استفاده در وب سایت خود باید در صفحه کاربریتان دامنه آنرا معرفی و ثبت کرده باشید تا مالکیت شما تایید گردد.

<vtwo data-type="urlshortener" data-key="87075078-9b23-5fc8-8ca9-60d8e6c9e611"></vtwo>

برخی ویژگی ها

زبان

API وی۲ از زبان انگلیسی نیز پشتیبانی می کند. بنابراین جهت تنظیم زبان کافیست آدرس را بشکل زیر تنظیم کنید(در قسمت src اسکریپت):

فارسی: https://vtwo.org/fa/apis/platform.js
English: https://vtwo.org/en/apis/platform.js
متن اختیاری

جهت تغییر متن به نوشته دلخواه خود بدینگونه عمل کنید:

<vtwo data-type="urlshortener" data-caption="لینک کوتاه(Short Link)" data-key="87075078-9b23-5fc8-8ca9-60d8e6c9e611"></vtwo>
استایل

جهت تغییر رنگ یا استایل بشکل زیر عمل کنید. فعلا یکرنگ مجزا تعریف شده است(aqua):

<vtwo data-type="urlshortener" data-style="aqua" data-key="87075078-9b23-5fc8-8ca9-60d8e6c9e611"></vtwo>
<vtwo data-type="urlshortener" data-style="aqua" data-caption="لینک کوتاه(Short Link)" data-key="87075078-9b23-5fc8-8ca9-60d8e6c9e611"></vtwo>