این وب سایت سرویسی را برای برنامه نویسان در نظر گرفته است که میتوانند از خدمات این نرم افزار در وب سایت های خود با استفاده از سرویس Restful استفاده کنند(api فال حافظ).
لیست تمامی توابع به شرح ذیل می باشد.
آدرس
http://emrani.net/hafez/api/hafez/fal
پارامتر ورودی
ندارد
مقدار خروجی
یک نسخه از مدل شرح داده شده
شرح عملیات
با قراخوانی این آدرس یکی از غزلیات حافظ بصورت کاملا تصادفی انتخاب و بصورت مدلی از JSON برگشت داده خواهد شد
آدرس
http://emrani.net/hafez/api/hafez/Search?keyword=value
پارامتر ورودی
keyword
مقدار خروجی
لیستی از مدل شرح داده شده
شرح عملیات
با ارسال پارامتر و فراخوانی این تابع لیستی از مدل JSON برگشت داده خواهد شد که عبارت مورد نظر در آنها استفاده شده است. در صورتی که پارامتر ارسال نشود خروجی تابع fal بازگشت داده خواهد شد.
آدرس
http://emrani.net/hafez/api/hafez/list
پارامتر ورودی
ندارد
مقدار خروجی
لیستی از مدل شرح داده شده
شرح عملیات
با فراخوانی این آدرس لیستی از مدل JSON شامل تمامی غزلیات برگشت داده خواهد شد
آدرس
http://emrani.net/hafez/api/hafez/list?start=number
پارامتر ورودی
start
مقدار خروجی
لیستی از مدل شرح داده شده
شرح عملیات
با فراخوانی این آدرس لیستی از مدل JSON شامل 10 عدد از غزلیات که از شماره پارامتر ورودی start شروع شده اند برگشت داده خواهد شد. اگر پارامتر ورودی ارسال نشود خروجی آدرس list نمایش داده خواهد شد
آدرس
http://emrani.net/hafez/api/hafez/list?start=number&count=number
پارامتر ورودی
start,count
مقدار خروجی
لیستی از مدل شرح داده شده
شرح عملیات
با فراخوانی این آدرس لیستی از مدل JSON شامل تعدادی به مقدار پارامتر count از غزلیات که از شماره پارامتر ورودی start شروع شده اند برگشت داده خواهد شد. اگر پارامتر ورودی ارسال نشود خروجی آدرس list نمایش داده خواهد شد
مدل بازگشتی توابع از نوع JSON بوده و شامل فیلدهای زیر میباشد:
id
شماره غزل
poem
در تابع list شامل بیت اول غزل، در تابع search شامل مصراع اول غزل، در توابع fal و poem شامل کل متن غزل می باشد. لازم به ذکر است که مصراع ها در غزلیات با کاراکتر new line از هم جدا شده اند
mp3
شامل صوت متن غزل با صدای دکتر موسوی گرمارودی به صورت Base64 String
total
تعداد کل غزلیات
کلام آخر : امیدوارم که توضیح مختصر درمورد api فال حافظ برای شما مفید بوده باشد.