مقدمة عن Untiny API v1.0
تم إنشاء الواجهة البرمجية (API) لـ Untiny لتساعد مطوري الويب و المبرمجين من الاستفادة من خدمات Untiny. و النسخة الحالية للـ API هي 1.0 و تتضمن الخدمات التالية:
-خدمة extract لاسترجاع العنوان الأساسي لعنوان مختصر.
-خدمة services لسرد مواقع الاختصار المدعومة.
و لتسهيل البرمجة على المطورين تم توفير مخرجات الـ API بثلاث صيغ وهي:
- النتيجة كنص عادي (text/plain).
- النتيجة بصيغة XML.
- النتيجة بصيغة JSON (للجافا سكربت).
و سيتم توفير النتائج بصيغة PHP - serialized قريبا إن شاءالله.
تغطي الـ API الأخطاء أيضا (errors) الصادرة أثناء عملية استخراج موقع، و لإعطاء نظرة عن الأخطاء و أرقامها فهي كالتالي:
error 0: Invalid URL
error 1: Unsupported service
error 2: Connection to service failed
error 3: Unable to get the original URL
خطأ 1 : العنوان المدخل غير صحيح
خطأ 2 : العنوان المدخل ليس موقع اختصار مدعوم
خطأ 3 : لم يتكمن من الاتصال بموقع الاختصار
خطأ 4 : لم يتمكن من العثور على العنوان الأساسي
لمشاهدة تفاصيل كل خدمة انتقل إليها من القائمة الجانبية.
ملاحظة: يمكنك خدمات الـ API مع جميع عناوين مواقع Untiny الآخرى و ليس فقط مع http://untiny.me. مواقع Untiny هي:
خدمة extract
خدمة extract لاسترجاع العنوان الأصلي و هي موجودة على العنوان:
http://untiny.me/api/1.0/extract
و لاسترجاع العنوان الأساسي لعنوان مختصر مثل http://tiny.pl/htk اكتب بعد عنوان الخدمة التالي
و النتيجة الافتراضية (default) هي نتيجة نصية XML.
أما إذا أردت تحديد نوع النتجية، فحددها بالمتغير format.
-مثال لتحديد النتيجة بنصية text/plain:
اكتب بعد العنوان format=text&
و النتيجة ستكون كتالي:
http://www.google.com
-مثال لتحديد النتيجة بصيغة XML:
اكتب بعد العنوان format=xml&
و النتيجة ستكون كتالي:
<?xml version="1.0"?>
<response>
<org_url>http://www.google.com</org_url>
</response>
نقطة: org_url أي original url
-مثال لتحديد النتيجة بصيغة JSON:
اكتب بعد العنوان format=json&
و النتيجة ستكون كتالي:
{"org_url":"http:\/\/www.google.com"}
الأخطاء
في حالة وقوع خطأ ما خلال عملية الاسترجاع، ستقوم الواجهة البرمجية بإظهار الخطأ و رقمه بالصيغة المطلوبة. للتعرف على الأخطاء و أرقامها راجع صفحة المقدمة.
-مثال خطأ بصيغة نصية text/plain:
error(0): Invalid URL
-مثال خطأ بصيغة نصية XML:
<response>
<error num="0">Invalid URL</error>
</response>
-مثال خطأ بصيغة نصيةJSON:
{"error":["0","Invalid URL"]}
خدمة services
خدمة services لسرد مواقع الاختصار المدعومة و هي موجودة على العنوان:
و النتيجة الافتراضية (default) هي نتيجة نصية XML.
أما إذا أردت تحديد نوع النتجية، فحددها بالمتغير format.
-مثال لتحديد النتيجة بنصية text/plain:
اكتب بعد العنوان format=text?
و النتيجة ستكون كتالي:
tiny.pl, tinyurl.com, is.gd, twurl.nl, bit.ly, ping.fm, snurl.com, snipr.com, snipurl.com, metamark.net, xrl.us, url.ie, wapurl.co.uk, url.co.uk, rubyurl.com, minilien.com, easyurl.net, yep.it, x.se
-مثال لتحديد النتيجة بصيغة XML:
اكتب بعد العنوان format=xml?
و النتيجة ستكون كتالي:
<?xml version="1.0"?>
<response>
<services>
<service>tiny.pl</service>
<service>tinyurl.com</service>
...
<service>x.se</service>
</services>
</response>
-مثال لتحديد النتيجة بصيغة JSON:
اكتب بعد العنوان format=json?
و النتيجة ستكون كتالي:
{"tiny.pl":"tiny.pl", "tinyurl.com":"tinyurl.com", ... , "x.se":"x.se"}
