راهنمای استفاده از وب سرویس LISH برای کوتاه کردن لینک

مقدمه

وب سرویس LISH که در ادامه این مطلب از آن با عنوان API یاد می‌کنیم یک وب سرویس RESTFul است که از ساختار داده JSON برای دریافت و ارسال اطلاعات استفاده می کند. به منظور تسهیل و امکان تست، API با استفاده از swagger مستند شده است و فایل مربوطه از آدرس زیر قابل دریافت است:

http://lish.ir/api.swg.yaml

برای بررسی این فایل ابزارهای مختلفی وجود دارد که پیشنهاد ما استفاده از swagger editor است که در آدرس زیر قابل دسترسی است و یکی از مهمترین ویژگی‌های آن این است که توانایی تولید کد client وب سرویس به اکثر زبان‌ای برنامه نویسی متداول را دارد که باعث افزایش سرعت پیاده‌سازی لایه ارتباط با API در نرم‌افزار شما خواهد شد:

https://swagger.io/swagger-editor/

کوتاه کردن لینک

برای کوتاه کردن لینک نیاز به ارسال authorization token نیست در صورتی که token در درخواست واصله وجود نداشته باشد API تنها امکان ساخت لینک ردیاب را می‌دهد و امکان دریافت آمار برای این لینک وجود ندارد.

Authorization Token

همانطور که در فایل swagger مشخص شده است API از استاندارد JSON Web Token (JWT) برای نگهداری و بازیابی session کاربر استفاده می‌کند. برای کسب اطلاعات بیشتر در مورد JWT می‌توانید به آدرس زیر مراجعه نمایید:

https://jwt.io/

طبق استاندارد هدرهای JWT به صورت زیر فرستاده می‌شود ( را با مقدار صحیح جایگزین نمایید):

Authorization: Bearer

برای دریافت token باید از endpoint لاگین (منظور POST: /login) استفاده کنید و در پاسخ دریافتی در صورت صحیح بودن نام کاربری و کلمه عبور authorization token در اختیار شما قرار خواهد گرفت. برای دریافت نام کاربری و کلمه عبور API همان نام کاربری و کلمه عبور شما در سایت lish هست و در صورتی که از endpoint ثبت نام (منظور POST: /register) برای ثبت نام استفاده کنید با استفاده از این نام کاربری و کلمه عبور می‌توانید به داشبورد سایت نیز وارد شوید.

به منظور حفظ امنیت API برای token های صادره زمان انقضا در نظر گرفته شده است بنابراین درصورتی که در فراخوانی برخی از endpointها با خطای 401 یا 403 روبرو شدید مطمئن شوید که token شما منقضی نشده باشد.