اے پی آئی
(API) اپلیکیشن پروگرامنگ انٹرفیس

موبائل اور ڈیسکٹاپ اپلیکیشن ڈیولپرز کے لئے ویب اے پی آئی کی سہولت فراہم کی گئی ہے۔ اے پی آی کے تین فنکشنز کے لئے یو آر آئیز درج ذیل ہیں:

URI

(تقطیع کے لئے)

http://aruuz.com/api/default/gettaqti

Parameters

text
value = "تقطیع کرنے کے لئے اشعار"

اس یو آر آئی کے ذریعے کئی اشعار کی تقطیع ایک ساتھ حاصل کر سکتے ہیں۔ نتیجے میں ہر ایک مصرعے کی تقطیع جتنی بحور پر منطبق ہو گئی، سب شامل ہوں گے۔ ان کو sort کرنا پروگرامر کے ذمہ داری ہے۔

مثال:

Example

http://aruuz.com/api/default/getTaqti?text=نقش فریادی ہے کس کی شوخیِ تحریر کا \n کاغذی ہے پیرہن ہر پیکرِ تصویر کا Note: \n or new line character may need to be converted to URL Encoding Reference (%0A).

نتیجہ:

Result (successful)

The result of this API call is in JSON format. [
{
"originalLine": "نقش فریادی ہے کس کی شوخیِ تحریر کا",
"words": [
"نقش",
"فریادی",
"ہے",
"کس",
"کی",
"شوخیِ",
"تحریر",
"کا"
],
"codes": [
"=-",
"===",
"-",
"=",
"=",
"=-=",
"==-",
"="
],
"meterName": "رمل مثمن محذوف",
"feet": " فاعلاتن فاعلاتن فاعلاتن فاعلن"
}
,
{
"originalLine":"کاغذی ہے پیرہن ہر پیکرِ تصویر کا",
"words":
[
"کاغذی",
"ہے",
"پیرہن",
"ہر",
"پیکرِ",
"تصویر",
"کا"
],
"codes":
[
"=-=",
"=",
"=-=",
"=",
"=-=",
"==-",
"="
],
"meterName":"رمل مثمن محذوف",
"feet":"فاعلاتن فاعلاتن فاعلاتن فاعلن "
}

]

Result (unsuccessful)

The result of this API call is in JSON format.
{
"Result":"ERROR",
"Message":"کوئی مانوس بحر نہیں ملی"
}

URI

(اصلاح کے لئے)

http://aruuz.com/api/default/getIslah

Parameters

text
value = "اصلاح کرنے کے لئے اشعار"

اس یو آر آئی کے ذریعے کئی اشعار کی ایک ساتھ اصلاح لی جا سکتی ہے۔ نتیجے میں صرف وہی بحر دکھائی جائے گی جو سب اشعار کی قریب ترین بحر ہو گی۔

مثال:

Example

http://aruuz.com/api/default/getislah?text=نقش فریادی ہے کس کی شوخی تحریر کا \n کاغذی ہے پیرہن ہر پیکرِ تصویر کا Note: \n or new line character may need to be converted to URL Encoding Reference (%0A).

نتیجہ:

Result (successful)

The result of this API call is in JSON format. [

{
"originalLine": "نقش فریادی ہے کس کی شوخی تحریر کا",
"words":["نقش","فریادی","ہے","کس","کی","شوخی","تحریر","کا"],
"codes":["=-","===","-","=","=","=-","==-","="],
"islah":["=-","===","-","=","=","=-","==?-","="],
"error":[false,false,false,false,false,false,true,false],
"meterName":"رمل مثمن محذوف",
"feet":" فاعلاتن فاعلاتن فاعلاتن فاعلن"
}

,

{
"originalLine":"کاغذی ہے پیرہن ہر پیکرِ تصویر کا",
"words":["کاغذی","ہے","پیرہن","ہر","پیکرِ","تصویر","کا"],
"codes":["=-=","=","=-=","=","=-=","==-","="],
"islah":["=-=","=","=-=","=","=-=","==-","="],
"error":[false,false,false,false,false,false,false],
"meterName":"رمل مثمن محذوف",
"feet":" فاعلاتن فاعلاتن فاعلاتن فاعلن"
}

]

Result (unsuccessful)

The result of this API call is in JSON format.
{
"Result":"ERROR",
"Message":"کوئی مانوس بحر نہیں ملی"
}

URI

(دوبارہ اصلاح کے لئے)

http://aruuz.com/api/default/getIslahOneLine

Parameters

text
value = "اصلاح کرنے کے لئے اشعار"
meter
value = "بحر کا نام، جس میں اصلاح مطلوب ہو"

اگر کسی مصرع کی تدوین کے بعد دوبارہ اصلاح حاصل کرنی ہو تو اس صورت میں اس یو آر آئی کا استعمال کریں۔ اس میں بحر کی تخصیص کرنا لازمی ہے۔

مثال:

Example

http://aruuz.com/api/default/getislahoneline?text=نقش فریادی ہے کس کی شوخی تحریر کا&&meter=رمل مثمن محذوف

نتیجہ:

Result (successful)

The result of this API call is in JSON format.
{
"originalLine": "نقش فریادی ہے کس کی شوخی تحریر کا",
"words":["نقش","فریادی","ہے","کس","کی","شوخی","تحریر","کا"],
"codes":["=-","===","-","=","=","=-","==-","="],
"islah":["=-","===","-","=","=","=-","==?-","="],
"error":[false,false,false,false,false,false,true,false],
"meterName":"رمل مثمن محذوف",
"feet":" فاعلاتن فاعلاتن فاعلاتن فاعلن"
}

کلائنٹ کے لئے جاوا سکرپٹ:

Client side Javascript/JQuery (Valid for all the three URIs)

The client application would require the following javascipt code. Note that this code requires JQuery library.
var uri = 'http://www.aruuz.com/api/default/gettaqti';
//use the uri suitable to the targetted functionality (Taqti, Islah, IslahOneLine)
var text = 'نقش فریادی ہے کس کی شوخیِ تحریر کا \n کاغذی ہے پیرہن ہر پیکرِ تصویر کا'; //assign your own lines to the 'text' variable
var values = {
"text": text
};

$.ajax({
type: "GET",
data: values,
url: uri,
contentType: "application/json",
success: function (data) {
// Add your code here to handle the api call result contained in 'data' variable in JSON format as explained above.
}
});

تبصرے