مستندات لازم برای توسعه دهندگان

این بخش برای توسعه دهندگان و وب مسترهایی تهیه شده است که تمایل دارند از api کوتاه کننده لینک دو و دو در وبسایت یا وبلاگ خود استفاده کنند و بدین وسیله به کاربران و بازدیدکنندگان وبسایت خود این امکان را بدهند تا بدون نیاز به مراجعه به سایت دو و دو ، لینک های خود را کوتاه کنند.

اگر به دنبال ابزارهای کوتاه کننده لینک نظیر افزونه های کروم و فایرفاکس هستید ، به صفحه ابزارها مراجعه نمایید.

کلیه درخواست ها باید به آدرس /http://api.yon.ir ارسال شوند. ارسال درخواست از طریق هر دو متد POST و GET امکان پذیر می باشد ، هر چند که استفاده از متد POST به توسعه دهندگان توصیه می گردد.
به عنوان مثال درخواست زیر با استفاده از متد GET انجام می پذیرد :

 

​http://api.yon.ir/?url=http%3A%2F%2Fgoogle.com%2Fhelp&wish=google

در درخواست فوق ، آدرس http://google.com به عنوان لینک بلند و رشته google به عنوان آدرس custom ارسال شده است.



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

پارامترهای ورودی :

​پارامترهای خروجی :



​در ادامه ، کد مربوط به ارسال یک درخواست نمونه را می آوریم که از فریم ورک JQuery استفاده می کند :

var params = {
    'url' : 'http://google.com',
    'wish' : 'google',
    'language' : 'en'
}

$.ajax{
    type : 'POST',
    url  : 'http://api.yon.ir/',
    data : params,
    dataType : 'json',
    cache : false,
    success : function(value){
        // do something with value.status , value.output , value.clicks
    }
    error : function(){
        // show some error
    }
}