سلام قرآن

نسخه ۶ مستندات رابط برنامه‌نویسی سلام قرآن

سلام قرآن انواع رابطه برنامه‌نویسی

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

ای‌پی‌آی ما RESTful API طراحی شده است و تمامی پاسخ‌ها در قالب جیسون قرار دارند. اگر شما ثبت نام کرده اید، می توانید کلید ای‌پی‌آی خود را از صفحه «حساب من» دریافت کنید. برو به حساب من

مخاطبان رابط برنامه‌نویسی

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

ما برای ای‌پی‌آی های عمومی، سه مخاطب در ذهن داریم.

  1. همکاران
  2. مشتریان
  3. توسعه‌دهندگان

مستندات ای‌پی‌آی با توضیحات مقدماتی درباره طراحی و تکنولوژی‌های پیاده‌سازی شروع شده است. در ادامه به دنبال اطلاعات بیشتر برای هر عملیات در نقطه پایان آن بیشتر بخوانید.

نقطه پایان

ای‌پی‌آی با ایجاد درخواست اچ‌تی‌تی‌پی‌اس به یک نشانی اینترنتی آغاز شده و متود‌های GET، POST، PUT، PATCH، HEAD و DELETE نحوه تعامل شما با اطلاعات موجود را تعیین می کند. تمامی آدرس‌ها تنها از طریق اچ‌تی‌تی‌پی‌اس قابل دسترسی هستند.

همه چیز (روش ها، پارامترها، و غیره) به شماره نسخه ثابت شده است، و هر ارتباط باید شامل یک نسخه باشد. آخرین نسخه،‌ نسخه ۶ است.

آدرس پایدار برای تمامی نقاط اتصال در نسخه ۶ از طریق اچ‌تی‌تی‌پی‌اس عبارت است از

https://salamquran.com/fa/api/v6/

درخواست‌ها

هر درخواستی که در اچ‌تی‌تی‌پی قابل اجرا هست به سادگی می‌تواند با درخواست نشانی اینترنتی صحیح از ای‌پی‌آی ارتباط برقرار کند. درخواست‌ها باید با استفاده از پروتکل اچ‌تی‌تی‌پی‌اس ساخته شوند تا ترافیک رمزگذاری شوند. این رابط به روش های مختلف بسته به نوع درخواست کاربر پاسخ می دهد.

متود میزان مصرف
GET

برای دریافت ساده اطلاعات در مورد چیزی، باید از روش GET استفاده کنید. اطلاعات درخواستی شما به صورت یک جیسون به دست شما خواهد رسید.

مقادیر تعریف شده توسط شی جیسون می تواند برای ایجاد درخواست‌های اضافی استفاده شود. هر درخواستی که با استفاده از روش GET فراخوانی می‌شوند تنها خواندنی است و بر روی هیچ یک از اشیای مورد نظر تاثیر نمی گذارد.

POST

برای ایجاد یک شی جدید، درخواست شما باید با روش POST ارسال شود.

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

DELETE

برای از بین بردن یک منبع و حذف آن از حساب و ناحیه کاربری خود، باید روش DELETE استفاده شود. اگر شی مشخص شده یافت شد، حذف خواهد شد. اگر آن شی پیدا نشد، عملیات پاسخی را نشان می‌دهد که شی یافت نشد.

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

PUT

برای به روز رسانی اطلاعات مربوط به یک منبع در حسابتان، روش PUT در دسترس است.

مانند روش DELETE، روش PUT خودکفا است. در این روش وضعیت هدف با توجه به مقادیر جدید ارائه شده و بدون در نظر گرفتن مقادیر جاری آن تنظیم می‌شوند. درخواست‌ها با استفاده از روش PUT نیازی به بررسی ویژگی های فعلی شی ندارند.

PATCH

برای به روز رسانی بخشی از اطلاعات مربوط به یک منبع در حسابتان، روش PATCH در دسترس است.

روش PUT و روش PATCH در نوع استفاده یکسان هستند.

HEAD

سرانجام، برای بازیابی اطلاعات هدر، باید از HEAD استفاده کنید تا هدرها را دریافت کنید. این فقط بازگشت هدر چیزی است که با درخواست GET دریافت می‌شود.

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

به عنوان مثال، هدر حاوی مقادیر فعلی میزان و مقدار زمان موجود تا زمان محدود شدن مجاز است. همچنین شامل معیارهای مربوط به تعداد کل اشیاء پیدا شده، اطلاعات صفحه بندی و طول کل محتوای است.

پاسخ‌ها

همه پاسخ‌ها در قالب جیسون قرار دارند

  • داده‌های درخواست شده در قسمت result قرار دارند.
  • اگر شما درخواست پاسخی از سرور داشتید این پاسخ حتما در قسمت result قرار دارد.
  • ما همچنین قسمت ok و نیز آرایه‌ای از msg را در پاسخ سرور قرار می‌دهیم
  • بعضی از پاسخ‌ها می‌توانند اطلاعات اضافی خود را در قسمت meta به شما اعلام کنند
  • هر شی از msg شامل حداقل دو قسمت type و text است

پاسخ موفقیت آمیز مثال

{
  "ok": true,
  "result":
  {
      "abc": 123,
      "def": 456
  }
  "msg":
  [
    {
      "type": "info",
      "text": "How are you!"
    }
  ]
}

پاسخ خطا مثال

{
  "ok": false,
  "msg":
  [
    {
      "type": "error",
      "text": "A verification code was sended to user"
    }
  ]
}

کدهای پاسخ اچ‌تی‌تی‌پی

وضعیت یک پاسخ را می توان از کد وضعیت اچ‌تی‌تی‌پی دریافت کرد.

کد وضعیت توضیح
200 OK درخواست موفق بود
304 Not Modified درخواست موفق بود
400 Bad Request درخواست نادرست بود
401 Unauthorized کاربر دسترسی لازم را برای انجام این کار ندارد
403 Forbidden درخواست مجوز لازم را برای اجرا ندارد
404 Not Found آدرس اشتباه
429 Too many requests کاربر از محدوده مجاز عبور کرده است
405 Method Not Allowed روش اچ‌تی‌تی‌پی نادرست ارائه شده است
415 Unsupported Media Type پاسخ جیسون معتبر نیست

POST
دریافت کلید دسترسی

دریافت کلید دسترسی برای برقراری ارتباط جدید با سرور

POST https://salamquran.com/fa/api/v6/token

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
appkey
string
کلید ای‌پی‌آی در بخش حساب کاربری خودتان تولید شده است
1234ec8e69c19ebb7c202ae1097aa404
الزامی
طول ۳۲

cURL مثال

curl -X POST https://salamquran.com/fa/api/v6/token -H 'appkey: 1234ec8e69c19ebb7c202ae1097aa404'

پاسخ مثال

{
  "ok": true,
  "result": {
    "token": "ec8e69c19ebb7c202ae1097aa40484e0",
    "create": "2019-02-19 14:04:32",
    "expire": "2019-02-19 14:07:32"
  }
}

POST
ثبت‌نام کاربر

افزودن کاربر جدید به سرویس

POST https://salamquran.com/fa/api/v6/android/user/add

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
token
string
توکن موقت شما
ec8e69c19ebb7c202ae1097aa40484e0
الزامی
طول ۳۲

پارامترهای الزامی

نام نوع توضیح مثال محدودیت‌ها
model
string
مثال
HUAWEI Y560-U02
الزامی
حداکثر طول ۱۰۰
serial
string
مثال
60D15B27D1259123456
الزامی
حداکثر طول ۱۰۰
manufacturer
string
مثال
HUAWEI
الزامی
حداکثر طول ۱۰۰
version
string
مثال
19
الزامی
حداکثر طول ۲۰
hardware
string
مثال
sc8830
اختیاری
حداکثر طول ۵۰
type
string
مثال
user
اختیاری
حداکثر طول ۵۰
board
string
مثال
HUAWEI
اختیاری
حداکثر طول ۱۰۰
id
string
مثال
HUAWEIY560-U02
اختیاری
حداکثر طول ۱۰۰
product
string
مثال
Y560-U02
اختیاری
حداکثر طول ۱۰۰
device
string
مثال
HWY560-U
اختیاری
حداکثر طول ۱۰۰
brand
string
مثال
HUAWEI
اختیاری
حداکثر طول ۱۰۰

cURL مثال

curl -X POST \
  https://salamquran.com/fa/api/v6/android/user/add \
  -H 'token: ec8e69c19ebb7c202ae1097aa40484e0' \
  -F 'model=HUAWEI Y560-U02' \
  -F 'serial=60D15B27D1259123456' \
  -F 'manufacturer=HUAWEI' \
  -F 'version=19' \
  -F 'hardware=sc8830' \
  -F 'type=user' \
  -F 'board=HUAWEI' \
  -F 'id=>HUAWEIY560-U02' \
  -F 'product=Y560-U02' \
  -F 'device=HWY560-U' \
  -F 'brand=HUAWEI'

پاسخ مثال

{
  "ok": true,
  "result": {
    "usercode": "3N5C",
    "zoneid": "android-ZW3N"
    "apikey": "87923bd0d04b30aa5f66b699c2698e3b",
  }
}

GET
دریافت جزئیات پروفایل

GET https://salamquran.com/fa/api/v6/profile

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲

cURL مثال

curl -X GET \
  https://salamquran.com/fa/api/v6/profile \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b'

پاسخ مثال

{
    "ok": true,
    "result": {
        "username": "Biqarar",
        "displayname": "Reza mohiti",
        "gender": "male",
        "title": "Programer",
        "mobile": "9891...",
        "verifymobile": "1",
        "status": "active",
        "avatar": "https://salamquran.com/static/images/logo.png",
        "datecreated": "2017-12-27 22:40:53",
        "datemodified": "2019-06-18 21:29:32",
        "birthday": "1990-01-16",
        "language": "fa",
        "firstname": "Reza",
        "lastname": "Mohitit",
        "bio": null,
        "email": null
    }
}

POST
به‌روزرسانی آواتار

برای تغییر آواتار خود کافیست آن را آپلود کنید

POST https://salamquran.com/fa/api/v6/profile

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲

پارامترهای الزامی

نام نوع توضیح مثال محدودیت‌ها
avatar
FILE
آدرس فایل شما برای آپلود
الزامی

cURL مثال

curl -X POST \
  https://salamquran.com/fa/api/v6/profile \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b' \
  -F avatar=@/home/reza/Desktop/yourfile.jpg

پاسخ مثال

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "User successfully updated"
    }
  ],
  "result": null
}

PATCH
به‌روزرسانی پروفایل

به‌روزرسانی جزئیات پروفایل

PATCH https://salamquran.com/fa/api/v6/profile

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲

پارامترها

نام نوع توضیح مثال محدودیت‌ها
displayname
string
مثال
Reza Mohiti
اختیاری
firstname
string
مثال
Reza
اختیاری
lastname
string
مثال
Mohiti
اختیاری
username
string
مثال
Biqarar
اختیاری
language
string
مثال
fa
اختیاری
birthday
string
مثال
1990-01-16
اختیاری
gender
string
مثال
male یا female
اختیاری
email
string
مثال
name@domain.com
اختیاری
website
string
مثال
http://yourwebsite.tld
اختیاری
instagram
string
نام کاربری شما در اینستاگرام
اختیاری
linkedin
string
نام کاربری شما در لینکداین
اختیاری
facebook
string
نام کاربری شما در فیسبوک
اختیاری
twitter
string
نام کاربری شما در تویتر
اختیاری
title
string
مثال
Programer
اختیاری
bio
string
مثال
your bio text
اختیاری

cURL مثال

curl -X PATCH \
  https://salamquran.com/fa/api/v6/profile \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b' \
  -F 'username=biqarar'\
  -F 'bio=programing is my life'

پاسخ مثال

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "User successfully updated"
    }
  ],
  "result": null
}

GET
دریافت متن درباره ما

GET https://salamquran.com/fa/api/v6/about

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/about

پاسخ مثال

{
  "ok": true,
  "result": {
    "language": "en",
    "title": "about",
    "slug": "about",
    "url": "https://salamquran.com/fa/api/v6/about",
    "content": "Your about text"
  }
}

GET
دریافت متن ماموریت

GET https://salamquran.com/fa/api/v6/mission

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/mission

پاسخ مثال

{
  "ok": true,
  "result": {
    "language": "en",
    "title": "mission",
    "slug": "mission",
    "url": "https://salamquran.com/fa/api/v6/mission",
    "content": "Your mission text"
  }
}

GET
دریافت متن چشم‌انداز

GET https://salamquran.com/fa/api/v6/vision

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/vision

پاسخ مثال

{
  "ok": true,
  "result": {
    "language": "en",
    "title": "vision",
    "slug": "vision",
    "url": "https://salamquran.com/fa/api/v6/vision",
    "content": "Your vision text"
  }
}

GET
دریافت متن و اطلاعات تماس

GET https://salamquran.com/fa/api/v6/contact

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/contact

پاسخ مثال

{
  "ok": true,
  "result": {
    "language": "en",
    "title": "contact",
    "slug": "contact",
    "url": "https://salamquran.com/fa/api/v6/contact",
    "content": "Your contact text"
  }
}

GET
دریافت آخرین نوشته‌ها

GET https://salamquran.com/fa/api/v6/posts

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/posts

پاسخ مثال

{
  "ok": true,
  "result": [
    {
      "id": "3Y",
      "language": "en",
      "title": "test",
      "seotitle": null,
      "slug": "test",
      "parent_url": [],
      "url": "test",
      "excerpt": "test",
      "subtitle": null,
      "content": "test content",
      "status": "publish",
      "publishdate": "2019-07-15 11:43:00",
      "datecreated": "2019-07-15 11:42:48"
    }
  ]
}

GET
دریافت آخرین پست‌ها

GET https://salamquran.com/fa/api/v6/posts/get

پارامترهای الزامی

نام نوع توضیح مثال محدودیت‌ها
id
code
مثال
3zC
الزامی

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/posts/get?id=3zC

پاسخ مثال

{
    "ok": true,
    "result": {
        "id": "3zC",
        "language": "fa",
        "subdomain": null,
        "title": "Post title",
        "seotitle": null,
        "slug": "post slug",
        "slug_raw": "post slug",
        "parent_url": [],
        "url": "post url",
        "link": "Post full url",
        "content": "Post content",
        "meta": {
            "thumb": "image.jpg",
            "gallery": [
            ],
            "download": {
                "title": "",
                "url": null,
                "target": false,
                "color": ""
            },
            "source": {
                "title": "",
                "url": null
            },
            "redirect": null
        },
        "file": {

        },
        "type": "post",
        "subtype": null,
        "special": "0",
        "comment": "closed",
        "count": null,
        "order": null,
        "status": "publish",
        "parent": null,
        "user_id": "5Xv",
        "publishdate": "2019-08-07 10:03:00",
        "datemodified": "2019-08-26 13:11:11",
        "datecreated": "2019-08-10 09:06:31",
        "subtitle": null,
        "excerpt": "expert"
    }
}

POST
ورود کاربر به سیستم

ورود کاربر به سیستم و دریافت apikey جدید برای این کاربر

POST https://salamquran.com/fa/api/v6/enter

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
token
string
توکن موقت شما
ec8e69c19ebb7c202ae1097aa40484e0
الزامی
طول ۳۲
برای دریافت این توکن بیشتر بخوانید
apikey
string
apikey موقت شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از صفحه اکانت خودتان دریافت شده است یا کاربری را ثبت‌نام کرده‌اید بیشتر بخوانید

پارامترهای الزامی

نام نوع توضیح مثال محدودیت‌ها
mobile
number
مثال
989121234567
الزامی
حداکثر طول ۱۲ حداقل طول ۷

cURL مثال

curl -X POST \
  https://salamquran.com/fa/api/v6/enter \
  -H 'token: ec8e69c19ebb7c202ae1097aa40484e0' \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b' \
  -F 'mobile=989121234567'

پاسخ مثال

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "The verification code sended to phone number"
    }
  ],
  "result": null
}

POST
تایید اعتبارسنجی کاربر

پس از ارسال کد اعتبارسنجی به کاربر، شما می‌بایست آن را تایید کنید

POST https://salamquran.com/fa/api/v6/enter/verify

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
token
string
توکن موقت شما
ec8e69c19ebb7c202ae1097aa40484e0
الزامی
طول ۳۲
برای دریافت این توکن بیشتر بخوانید
apikey
string
apikey موقت شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از صفحه اکانت خودتان دریافت شده است یا کاربری را ثبت‌نام کرده‌اید بیشتر بخوانید

پارامترهای الزامی

نام نوع توضیح مثال محدودیت‌ها
mobile
number
مثال
989121234567
الزامی
حداکثر طول ۱۲ حداقل طول ۷
verifycode
int
مثال
12345
الزامی
طول ۵

cURL مثال

curl -X POST \
  https://salamquran.com/fa/api/v6/enter \
  -H 'token: ec8e69c19ebb7c202ae1097aa40484e0' \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b' \
  -F 'mobile=989121234567'
  -F 'verifycode=12345'

پاسخ مثال

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "Code is ok"
    }
  ],
  "result": {
    "apikey": "891920636c6cd1993baf0ab5eaac48ce"
  }
}

GET
دریافت لیست زبان‌ها

GET https://salamquran.com/fa/api/v6/language

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/language

پاسخ مثال

{
  "ok": true,
  "result": {
    "fa": {
      "name": "fa",
      "direction": "rtl",
      "iso": "fa_IR",
      "localname": "فارسی",
      "country": [
          "Iran"
      ]
    },
    "en": {
      "name": "en",
      "direction": "ltr",
      "iso": "en_US",
      "localname": "English",
      "country": [
          "United Kingdom",
          "United States"
      ]
    }
  }
}

POST
دریافت تعداد پیام

برای دریافت اینکه آیا پیام جدیدی دارید یا خیر

POST https://salamquran.com/fa/api/v6/smile

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از حساب کاربری خودتان دریافت می‌شود بیشتر بخوانید

cURL مثال

curl -X POST \
  https://salamquran.com/fa/api/v6/smile \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b' \

پاسخ مثال

{
  "ok": true,
  "result": {
    "notif_new": true,
    "notif_count": 1
  }
}

POST
دریافت لیست پیام‌ها

دریافت لیست اطلاع‌رسانی‌های شما

POST https://salamquran.com/fa/api/v6/notif

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از صفحه اکانت خودتان دریافت شده است بیشتر بخوانید

پاسخ

نام نوع توضیح مثال
id
String
مثال
3NW
readdate
Date time
اگر گاربر این پیام را نخوانده باشید این مقدار خالی است و در غیر این صورت تاریخ خوانده شدن در این مقدار قرار دارد
مثال
2019-02-10 08:14:12
datecreated
Date time
مثال
2019-02-09 07:15:13
title
String
مثال
Notif title
icon
String
مثال
home بیشتر بخوانید
cat
String
مثال
Notif category
excerpt
String
مثال
Notif excerpt
text
String
مثال
Notif text
image
URL
مثال
https://salamquran.com/static/images/logo.png
footer
String
مثال
Notif Footer
url
URL
مثال
https://salamquran.com

cURL مثال

curl -X POST \
  https://salamquran.com/fa/api/v6/notif \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b' \

پاسخ مثال

{
  "ok": true,
  "result": [
    {
      "id": "36v",
      "readdate": null,
      "datecreated": "2019-02-09 07:15:13",
      "title": "Notif title",
      "icon": "test icon",
      "cat": "category of notif",
      "excerpt": "Notif excerpt",
      "text" : "Notif text",
      "image" : "https://salamquran.com/static/images/logo.png",
      "footer" : "Notif footer",
      "url" : "https://salamquran.com/static"
    }
  ]
}

GET
دریافت اطلاعات اندروید

دریافت جزئیات مثل صفحات، لیست زبان‌ها، ترجمه‌ها و سایر اطلاعات.

GET https://salamquran.com/fa/api/v6/android

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/android

پاسخ مثال

{
  "ok": true,
  "result": {
    "version": "1.1.1",
    "lang_list": {
      "fa": {
        "name": "fa",
        "direction": "rtl",
        "iso": "fa_IR",
        "localname": "فارسی",
        "country": [
          "Iran"
        ]
      },
      "en": {
        "name": "en",
        "direction": "ltr",
        "iso": "en_US",
        "localname": "English",
        "country": [
          "United Kingdom",
          "United States"
        ]
      }
    }
  }
}

GET
دریافت اطلاعات مورد نیاز اپلیکیشن

دریافت جزئیات مثل صفحات، لیست زبان‌ها، ترجمه‌ها و سایر اطلاعات.

GET https://salamquran.com/fa/api/v6/app

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/app

پاسخ مثال

{
  "ok": true,
  "result": {
    "lang_list": {
      "fa": {
        "name": "fa",
        "direction": "rtl",
        "iso": "fa_IR",
        "localname": "فارسی",
        "country": [
          "Iran"
        ]
      },
      "en": {
        "name": "en",
        "direction": "ltr",
        "iso": "en_US",
        "localname": "English",
        "country": [
          "United Kingdom",
          "United States"
        ]
      }
    }
    ...
  }
}

GET
دریافت لیست‌ نشست‌ها

دریافت اطلاعات و جزئیات نشست‌های فعال شما

GET https://salamquran.com/fa/api/v6/session

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از صفحه اکانت خودتان دریافت شده است

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/session

پاسخ مثال

{
  "ok": true,
  "result": [
    {
      "id": "3N",
      "ip": "127.0.0.1",
      "last": "Tuesday 28 May 2019 16:13:49",
      "browser": "Chrome",
      "browserVer": "74.0.3729.169",
      "os": "Linux",
      "os_version": null
    },
    {
      "id": "3J",
      "ip": "127.0.0.1",
      "last": "Friday 17 May 2019 14:18:16",
      "browser": "Chrome",
      "browserVer": "74.0.3729.157",
      "os": "Linux",
      "os_version": null
    }
  ]
}

POST
مسدود‌سازی نشست‌ها

مسدود کردن یک نشست یا همه نشست‌های فعال

POST https://salamquran.com/fa/api/v6/session

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از صفحه اکانت خودتان دریافت شده است

پارامترها

نام نوع توضیح مثال
type
String
terminate یا terminateall
id
String
مثال
3N
اگر نوع بر روی 'terminate' تنظیم شده باشد ارسال 'id' الزامی است

cURL مثال

curl -X POST \
  https://salamquran.com/fa/api/v6/session \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b' \
  -F 'type=terminate' \
  -F 'id=3N'

پاسخ مثال

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "This Session was terminated"
    }
  ],
  "result": true
}

GET
دریافت یک آیه

GET https://salamquran.com/fa/api/v6/aya

پارامترها

نام نوع توضیح مثال محدودیت‌ها
index
number
مثال
1408

شما باید مقدار index را بین ۱ و ۶۲۳۶ وارد کنید

الزامی

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/aya?index=1408

پاسخ مثال

{
  "ok": true,
  "result": {
    "index": "1408",
    "sura": "10",
    "aya": "44",
    "text": "إِنَّ ٱللَّهَ لَا يَظْلِمُ ٱلنَّاسَ شَيْـًٔا وَلَٰكِنَّ ٱلنَّاسَ أَنفُسَهُمْ يَظْلِمُونَ",
    "simple": "إن الله لا يظلم الناس شيئا ولكن الناس أنفسهم يظلمون",
    "juz": "11",
    "hizb": "22",
    "page": "214",
    "word": "10",
    "sajdah": null,
    "sajdah_number": null,
    "rub": "85",
    "verse_key": "10:44",
    "theletter": null,
    "sortnozol": null,
    "sortalphabet": null,
    "type": null,
    "nim": "43",
    "sura_detail": {
      "index": "10",
      "ayas": "109",
      "start": "1364",
      "end": null,
      "name": "يونس",
      "tname": "Yunus",
      "ename": "Jonah",
      "type": "meccan",
      "order": "51",
      "orderalphabet": null,
      "orderquran": null,
      "word": "1843",
      "theletter": "7567",
      "startjuz": "11",
      "endjuz": "11",
      "startpage": "208",
      "endpage": "221"
    },
    "translate": {
      "index": "1408",
      "sura": "10",
      "aya": "44",
      "text": "قطعاً خداوند هیچ ظلمى به مردم نمى‌کند، امّا این خود مردمند که به خویشتن ستم مى‌کنند."
    }
  }
}

GET
دریافت لیست سوره‌ها

دریافت لیست سوره‌ها به همراه جزئیات مانند تعداد آیات، نوع، شماره و ...

GET https://salamquran.com/fa/api/v6/sura/list

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/sura/list

پاسخ مثال

{
  "ok": true,
  "result": [
    {
      "index": "1",
      "ayas": "7",
      "name": "الفاتحة",
      "tname": "Al-Fatihah",
      "ename": "The Opener",
      "type": "meccan",
      "order": "5",
      "word": "29",
      "theletter": "142"
    }
    ...
  ]
}

GET
دریافت آیات یک سوره

دریافت لیست آیات یک سوره

GET https://salamquran.com/fa/api/v6/sura

پارامترها

نام نوع توضیح مثال محدودیت‌ها
index
number
مثال
108

شما باید شماره فهرست را بین ۱ و ۱۱۴ تنظیم کنید

الزامی
start
number
مثال
2

شماره آیه اول

حداکثر حداکثر آیات آن سوره

اختیاری
limit
number
مثال
10

تعداد رکورد‌های نمایشی

حداکثر ۲۰

اختیاری

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/sura?index=108

پاسخ مثال

{
    "ok": true,
    "result": [
        {
            "index": "6205",
            "sura": "108",
            "aya": "1",
            "text": "إِنَّآ أَعْطَيْنَٰكَ ٱلْكَوْثَرَ",
            "simple": "إنا أعطيناك الكوثر",
            "juz": "30",
            "hizb": "60",
            "page": "602",
            "word": "3",
            "sajdah": null,
            "sajdah_number": null,
            "rub": "240",
            "verse_key": "108:1",
            "theletter": null,
            "sortnozol": null,
            "sortalphabet": null,
            "type": null
        },
        {
            "index": "6206",
            "sura": "108",
            "aya": "2",
            "text": "فَصَلِّ لِرَبِّكَ وَٱنْحَرْ",
            "simple": "فصل لربك وانحر",
            "juz": "30",
            "hizb": "60",
            "page": "602",
            "word": "3",
            "sajdah": null,
            "sajdah_number": null,
            "rub": "240",
            "verse_key": "108:2",
            "theletter": null,
            "sortnozol": null,
            "sortalphabet": null,
            "type": null
        },
        {
            "index": "6207",
            "sura": "108",
            "aya": "3",
            "text": "إِنَّ شَانِئَكَ هُوَ ٱلْأَبْتَرُ",
            "simple": "إن شانئك هو الأبتر",
            "juz": "30",
            "hizb": "60",
            "page": "602",
            "word": "4",
            "sajdah": null,
            "sajdah_number": null,
            "rub": "240",
            "verse_key": "108:3",
            "theletter": null,
            "sortnozol": null,
            "sortalphabet": null,
            "type": null
        }
    ]
}

GET
دریافت آیات یک سوره به صورت کلمه به کلمه

دریافت لیست آیات یک سوره به صورت کلمه به کلمه

GET https://salamquran.com/fa/api/v6/sura/wbw

پارامترها

نام نوع توضیح مثال محدودیت‌ها
index
number
مثال
108

شما باید شماره فهرست را بین ۱ و ۱۱۴ تنظیم کنید

الزامی
start
number
مثال
2

شماره آیه اول

حداکثر حداکثر آیات آن سوره

اختیاری
limit
number
مثال
10

تعداد رکورد‌های نمایشی

حداکثر ۲۰

اختیاری

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/sura/wbw?index=108

پاسخ مثال

{
    "ok": true,
    "result": [
        {
            "id": "88078",
            "aya": "1",
            "sura": "108",
            "position": "1",
            "verse_key": "108:1",
            "text": "إِنَّا",
            "simple": "انا",
            "juz": null,
            "hizb": null,
            "rub": null,
            "page": "602",
            "class_name": "p602",
            "line": "14",
            "code": "ﮆ",
            "code_v3": "ﮆ",
            "char_type": "word",
            "audio": "/108_001_001.mp3",
            "translation": "Indeed, We"
        },
        {
            "id": "88079",
            "aya": "1",
            "sura": "108",
            "position": "2",
            "verse_key": "108:1",
            "text": "أَعْطَيْنَاكَ",
            "simple": "اعطيناك",
            "juz": null,
            "hizb": null,
            "rub": null,
            "page": "602",
            "class_name": "p602",
            "line": "14",
            "code": "ﮇ",
            "code_v3": "ﮇ",
            "char_type": "word",
            "audio": "/108_001_002.mp3",
            "translation": "have given you"
        },
       ...
    ]
}

GET
دریافت آیات یک صفحه

دریافت لیست آیات یک صفحه

GET https://salamquran.com/fa/api/v6/page

پارامترها

نام نوع توضیح مثال محدودیت‌ها
index
number
مثال
1

شما باید شماره فهرست را بین ۱ و ۶۰۴ تنظیم کنید

الزامی

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/page?index=1

پاسخ مثال

{
    "ok": true,
    "result": [
        {
            "index": "1",
            "sura": "1",
            "aya": "1",
            "text": "بِسْمِ ٱللَّهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ",
            "simple": "بسم الله الرحمن الرحيم",
            "juz": "1",
            "hizb": "1",
            "page": "1",
            "word": "4",
            "sajdah": null,
            "sajdah_number": null,
            "rub": "1",
            "verse_key": "1:1",
            "theletter": null,
            "sortnozol": null,
            "sortalphabet": null,
            "type": null
        },
        {
            "index": "2",
            "sura": "1",
            "aya": "2",
            "text": "ٱلْحَمْدُ لِلَّهِ رَبِّ ٱلْعَٰلَمِينَ",
            "simple": "الحمد لله رب العالمين",
            "juz": "1",
            "hizb": "1",
            "page": "1",
            "word": "4",
            "sajdah": null,
            "sajdah_number": null,
            "rub": "1",
            "verse_key": "1:2",
            "theletter": null,
            "sortnozol": null,
            "sortalphabet": null,
            "type": null
        },
       ...
    ]
}

GET
دریافت آیات یک صفحه به صورت کلمه به کلمه

دریافت لیست آیات یک صفحه به صورت کلمه به کلمه

GET https://salamquran.com/fa/api/v6/page/wbw

پارامترها

نام نوع توضیح مثال محدودیت‌ها
index
number
مثال
604

شما باید شماره فهرست را بین ۱ و ۶۰۴ تنظیم کنید

الزامی

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/page/wbw?index=604

پاسخ مثال

{
  "ok": true,
  "result": [
    {
      "detail": {
        "line_type": "start_sura",
        "line": 1,
        "index": "112",
        "ayas": "4",
        "start": "6221",
        "end": null,
        "name": "الإخلاص",
        "tname": "Al-Ikhlas",
        "ename": "The Sincerity",
        "type": "meccan",
        "order": "22",
        "orderalphabet": null,
        "orderquran": null,
        "word": "19",
        "theletter": "47",
        "startjuz": "30",
        "endjuz": "30",
        "startpage": "604",
        "endpage": "604"
      }
    },
    {
      "detail": {
        "line_type": "besmellah",
        "line": 2
      }
    },
    {
      "detail": {
        "index": null,
        "text": null,
        "simple": null,
        "juz": null,
        "hizb": null,
        "word": null,
        "sajdah": null,
        "sajdah_number": null,
        "rub": null,
        "aya": "1",
        "sura": "112",
        "verse_key": "112:1",
        "verse_title": "قرآن - سوره ۱۱۲ اخلاص - آیه ۱",
        "verse_url": "http://salamquran.local/fa/s112/1",
        "page": "604",
        "line_type": "line",
        "line": 3,
        "audio": "https://dl.salamquran.com/ayat/parhizgar-murattal-48/112001.mp3",
        "translate": false
      },
      "word": [
        {
          "id": "88174",
          "index": "6222",
          "aya": "1",
          "sura": "112",
          "position": "1",
          "verse_key": "112:1",
          "text": "قُلْ",
          "simple": "قل",
          "juz": "30",
          "hizb": "60",
          "rub": "240",
          "page": "604",
          "class_name": "p604",
          "line": "3",
          "code": "ﭑ",
          "code_v3": "ﭑ",
          "char_type": "word",
          "audio": "112/112_001_001.mp3",
          "translation": "Say",
          "nim": "120",
          "audio_key": "112_001_001"
        },
        {
          "id": "88175",
          "index": "6222",
          "aya": "1",
          "sura": "112",
          "position": "2",
          "verse_key": "112:1",
          "text": "هُوَ",
          "simple": "هو",
          "juz": "30",
          "hizb": "60",
          "rub": "240",
          "page": "604",
          "class_name": "p604",
          "line": "3",
          "code": "ﭒ",
          "code_v3": "ﭒ",
          "char_type": "word",
          "audio": "112/112_001_002.mp3",
          "translation": "He",
          "nim": "120",
          "audio_key": "112_001_002"
        },
        ...
      ]
    }
  ]
}

GET
دریافت اطلاعات تمامی جزء‌ها به همراه اطلاعات سوره‌های درون جزء

دریافت اطلاعات تمامی جزء‌هابه همراه اطلاعات سوره‌های درون جزء

GET https://salamquran.com/fa/api/v6/juz/sura

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/juz/sura

پاسخ مثال

{
  "ok": true,
  "result": {
    "ok": true,
    "result": [
      {
        "index": 1,
        "startpage": 1,
        "sura": [
          {
            "index": "1",
            "ayas": "7",
            "start": "0",
            "end": null,
            "name": "الفاتحة",
            "tname": "Al-Fatihah",
            "ename": "The Opener",
            "type": "meccan",
            "order": "5",
            "orderalphabet": null,
            "orderquran": null,
            "word": "29",
            "theletter": "142",
            "startjuz": "1",
            "endjuz": "1",
            "startpage": "1",
            "endpage": "1"
          },
          {
            "index": "2",
            "ayas": "286",
            "start": "7",
            "end": null,
            "name": "البقرة",
            "tname": "Al-Baqarah",
            "ename": "The Cow",
            "type": "medinan",
            "order": "87",
            "orderalphabet": null,
            "orderquran": null,
            "word": "6144",
            "theletter": "25500",
            "startjuz": "1",
            "endjuz": "3",
            "startpage": "2",
            "endpage": "49"
          }
        ]
      },
      {
        "index": 2,
        "startpage": 22
      },
      {
        "index": 3,
        "startpage": 42,
        "sura": [
          {
            "index": "3",
            "ayas": "200",
            "start": "293",
            "end": null,
            "name": "آل عمران",
            "tname": "Ali 'Imran",
            "ename": "Family of Imran",
            "type": "medinan",
            "order": "89",
            "orderalphabet": null,
            "orderquran": null,
            "word": "3505",
            "theletter": "14525",
            "startjuz": "3",
            "endjuz": "4",
            "startpage": "50",
            "endpage": "76"
          }
        ]
      },
      ...
    ]
  }
}

GET
دریافت اطلاعات تمامی جزء‌هابه همراه اطلاعات حزب‌های درون جزء

دریافت اطلاعات تمامی جزء‌هابه همراه اطلاعات حزب‌های درون جزء

GET https://salamquran.com/fa/api/v6/juz/hizb

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/juz/hizb

پاسخ مثال

{
  "ok": true,
  "result": {
    "1": {
      "1": {
        "1": {
          "index_rub": 1,
          "index_hizb": 1,
          "rub": "1",
          "sura": "1",
          "page": "1",
          "sura_detail": {
            "index": "1",
            "ayas": "7",
            "start": "0",
            "end": null,
            "name": "الفاتحة",
            "tname": "Al-Fatihah",
            "ename": "The Opener",
            "type": "meccan",
            "order": "5",
            "orderalphabet": null,
            "orderquran": null,
            "word": "29",
            "theletter": "142",
            "startjuz": "1",
            "endjuz": "1",
            "startpage": "1",
            "endpage": "1"
          },
          "aya": "1",
          "text": "بِسْمِ ٱللَّهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ",
          "simple": "بسم الله الرحمن الرحيم",
          "first_word": "بِسْمِ ٱللَّهِ ٱلرَّحْمَٰنِ ٱلرَّحِيمِ",
          "first_word_simple": "بسم الله الرحمن الرحيم"
        },
        "2": {
          "index_rub": 2,
          "index_hizb": 1,
          "rub": "2",
          "sura": "2",
          "page": "5",
          "sura_detail": {
            "index": "2",
            "ayas": "286",
            "start": "7",
            "end": null,
            "name": "البقرة",
            "tname": "Al-Baqarah",
            "ename": "The Cow",
            "type": "medinan",
            "order": "87",
            "orderalphabet": null,
            "orderquran": null,
            "word": "6144",
            "theletter": "25500",
            "startjuz": "1",
            "endjuz": "3",
            "startpage": "2",
            "endpage": "49"
          },
          "aya": "26",
          "text": "إِنَّ ٱللَّهَ لَا يَسْتَحْىِۦٓ أَن يَضْرِبَ مَثَلًا مَّا بَعُوضَةً فَمَا فَوْقَهَا فَأَمَّا ٱلَّذِينَ ءَامَنُوا۟ فَيَعْلَمُونَ أَنَّهُ ٱلْحَقُّ مِن رَّبِّهِمْ وَأَمَّا ٱلَّذِينَ كَفَرُوا۟ فَيَقُولُونَ مَاذَآ أَرَادَ ٱللَّهُ بِهَٰذَا مَثَلًا يُضِلُّ بِهِۦ كَثِيرًا وَيَهْدِى بِهِۦ كَثِيرًا وَمَا يُضِلُّ بِهِۦٓ إِلَّا ٱلْفَٰسِقِينَ",
          "simple": "إن الله لا يستحيي أن يضرب مثلا ما بعوضة فما فوقها فأما الذين آمنوا فيعلمون أنه الحق من ربهم وأما الذين كفروا فيقولون ماذا أراد الله بهذا مثلا يضل به كثيرا ويهدي به كثيرا وما يضل به إلا الفاسقين",
          "first_word": "إِنَّ ٱللَّهَ لَا يَسْتَحْىِۦٓ أَن يَضْرِبَ",
          "first_word_simple": "إن الله لا يستحيي أن يضرب"
        },
        ...
      }
    }
  }
}

GET
دریافت دسترسی سریع

دریافت لیست دسترسی‌های سریع به برخی از آیات، سوره‌ها و چیز‌های دیگر

GET https://salamquran.com/fa/api/v6/nav/quick

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/nav/quick

پاسخ مثال

{
  "ok": true,
  "result": [
    {
      "title": "فاتحه",
      "desc": null,
      "url": "http://salamquran.local/fa/s1"
    },
    {
      "title": "الرحمان",
      "desc": null,
      "url": "http://salamquran.local/fa/s55"
    },
    {
      "title": "ملک",
      "desc": null,
      "url": "http://salamquran.local/fa/s67"
    },
    {
      "title": "یاسین",
      "desc": null,
      "url": "http://salamquran.local/fa/s36"
    },
    {
      "title": "واقعه",
      "desc": null,
      "url": "http://salamquran.local/fa/s56"
    }
  ]
}

GET
دریافت آیه روز

هر روز یک آیه نمایش داده خواهد شد

GET https://salamquran.com/fa/api/v6/aya/day

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/aya/day

پاسخ مثال

{
  "ok": true,
  "result": {
    "index": "99",
    "sura": "2",
    "aya": "92",
    "text": "وَلَقَدْ جَآءَكُم مُّوسَىٰ بِٱلْبَيِّنَٰتِ ثُمَّ ٱتَّخَذْتُمُ ٱلْعِجْلَ مِنۢ بَعْدِهِۦ وَأَنتُمْ ظَٰلِمُونَ",
    "simple": "ولقد جاءكم موسى بالبينات ثم اتخذتم العجل من بعده وأنتم ظالمون",
    "juz": "1",
    "hizb": "2",
    "page": "14",
    "word": "11",
    ...
  }
}

GET
دریافت صفحه روز

هر روز یک صفحه نمایش داده خواهد شد

GET https://salamquran.com/fa/api/v6/page/day

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/page/day

پاسخ مثال

{
  "ok": true,
  "result": {
    "page": 449,
    "date": "2019-06-12"
  }
}

GET
برنامه محاسبه زمان حفظ

ارسال زمان خود و دریافت پاسخ

GET https://salamquran.com/fa/api/v6/hefz/time

پارامترها

نام نوع توضیح مثال محدودیت‌ها
mytime
number
مثال
10

دقیقه

الزامی

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/hefz/time?mytime=10

پاسخ مثال

{
  "ok": true,
  "result": {
      "year": 36,
      "month": 3
  }
}

POST
افزودن علاقه‌مندی جدید

افزودن آیات، سوره‌ها و صفحه به لیست علاقه‌مندی‌ها

POST https://salamquran.com/fa/api/v6/fav/add

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از صفحه اکانت خودتان دریافت شده است

پارامترها

نام نوع توضیح مثال محدودیت‌ها
type
string
مثال
sura

["sura", "aya", "page"]

الزامی
sura
number
مثال
5

1-114

الزامی اگر type بر روی aya یا sura تنظیم شده است
aya
number
مثال
1

شماره آیه در آن سوره

الزامی اگر type بر روی aya تنظیم شده است
page
number
مثال
100

1-604

الزامی اگر type بر روی page تنظیم شده است

cURL مثال

curl -X POST \
  https://salamquran.com/fa/api/v6/fav/add \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6' \
  -F 'type=sura' \
  -F 'sura=5'

پاسخ مثال

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "Favorites saved"
    }
  ],
  "result": true
}

POST
ویرایش توضیحات علاقه‌مندی

POST https://salamquran.com/fa/api/v6/fav/edit

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از صفحه اکانت خودتان دریافت شده است

پارامترها

نام نوع توضیح مثال محدودیت‌ها
id
code
مثال
c

الزامی
desc
string
مثال
test
الزامی

حداکثر ۲۰۰ کاراکتر

cURL مثال

curl -X POST \
  https://salamquran.com/fa/api/v6/fav/edit \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6' \
  -F 'id=c' \
  -F 'desc=test'

پاسخ مثال

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "Description saved"
    }
  ],
  "result": true
}

POST
حذف یک علاقه‌مندی ذخیره شده

POST https://salamquran.com/fa/api/v6/fav/remove

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از صفحه اکانت خودتان دریافت شده است

پارامترها

نام نوع توضیح مثال محدودیت‌ها
id
code
مثال
c

الزامی

cURL مثال

curl -X POST \
  https://salamquran.com/fa/api/v6/fav/remove \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6' \
  -F 'id=c'

پاسخ مثال

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "Favorites removed"
    }
  ],
  "result": true
}

GET
لیست علاقه‌مندی‌های شما

GET https://salamquran.com/fa/api/v6/fav/list

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از صفحه اکانت خودتان دریافت شده است

پارامترها

نام نوع توضیح مثال محدودیت‌ها
id
code
مثال
c

الزامی

cURL مثال

curl -X GET \
  https://salamquran.com/fa/api/v6/fav/list \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6'

پاسخ مثال

{
  "ok": true,
  "pagination": {
    "desc": "page 1 of 1 - Show record 1 to 5 of 5",
    "page": 1,
    "total_page": 1,
    "limit": 10,
    "total_rows": 5
  },
  "result": [
    {
      "id": "c",
      "user_id": "4",
      "page": null,
      "sura": "2",
      "aya": null,
      "desc": null,
      "type": "sura",
      "datecreated": "2019-07-16 12:37:11"
    },
    {
      "id": "d",
      "user_id": "4",
      "page": null,
      "sura": "3",
      "aya": null,
      "desc": null,
      "type": "sura",
      "datecreated": "2019-07-16 12:37:13"
    }
  ]
}

GET
دریافت لیست گرو‌ه‌های مکانیزم آموزش

GET https://salamquran.com/fa/api/v6/lms/group

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از صفحه اکانت خودتان دریافت شده است

cURL مثال

curl -X GET \
  https://salamquran.com/fa/api/v6/lms/group \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6'

پاسخ مثال

{
  "ok": true,
  "pagination": {
    "desc": "page 1 of 1 - Show record 1 to 2 of 2",
    "page": 1,
    "total_page": 1,
    "limit": 10,
    "total_rows": 2
  },
  "result": [
    {
      "id": "3",
      "title": "ناس تا زلزال",
      "type": null,
      "desc": "آموزش سوره‌های ناس تا زلزال",
      "sort": "1",
      "status": "enable",
      "datecreated": "2019-07-26 16:27:17",
      "file": "https://salamquran.com/static/siftal/images/default/logo.png"
    },
    {
      "id": "4",
      "title": "فلق تا ضحی",
      "type": null,
      "desc": "مکانیزم آموزش سوره‌های فلق تا ضحی",
      "sort": "2",
      "status": "enable",
      "datecreated": "2019-07-26 16:31:03",
      "file": "https://salamquran.com/static/siftal/images/default/logo.png"
    },

  ]
}

GET
دریافت لیست مراحل موجود در یک گروه

GET https://salamquran.com/fa/api/v6/lms/levellist

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از صفحه اکانت خودتان دریافت شده است

پارامترها

نام نوع توضیح مثال محدودیت‌ها
id
code
مثال
3

شناسه گروه

الزامی

cURL مثال

curl -X GET \
  https://salamquran.com/fa/api/v6/lms/levellist?id=3 \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6'

پاسخ مثال

{
  "ok": true,
  "result": [
      {
        "id": "d",
        "lm_group_id": "3",
        "title": "آزمون سراسری تابستان",
        "desc": null,
        "type": "quran",
        "type_title": "Quran",
        "quranfrom": "1",
        "quranto": "36",
        "besmellah": "1",
        "file": "http://salamquran.local/static/siftal/images/default/logo.png",
        "setting": null,
        "sort": null,
        "ratio": null,
        "unlockscore": null,
        "status": "enable",
        "datecreated": "2019-07-27 15:53:15",
        "questionrandcount": null,
        "filepic": null,
        "userstar": "3"
      },
      {
        "id": "4",
        "lm_group_id": "3",
        "title": "آموزش روخوانی سوره ناس",
        "desc": "در این آموزش شما با نحوه صحیح قرائت سوره ناس آشنا خواهید شد",
        "type": "quranvideo",
        "type_title": "Quran video",
        "quranfrom": "1",
        "quranto": "10",
        "besmellah": "1",
        "file": "https://mov.tebyan.net/1395/02/Ensan1_2_174931.mp4",
        "setting": null,
        "sort": "1",
        "ratio": "10",
        "unlockscore": "20",
        "status": "enable",
        "datecreated": "2019-07-26 16:54:10",
        "questionrandcount": null,
        "filepic": "https://qhkarimeh.ir/files/1/440-d3dbecfa8f97078c6eb2ada550a03718.jpg",
        "userstar": "3"
      }
  ]
}

GET
دریافت جزئیات یک مرحله مکانیزم آموزش

GET https://salamquran.com/fa/api/v6/lms/level

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از صفحه اکانت خودتان دریافت شده است

پارامترها

نام نوع توضیح مثال محدودیت‌ها
id
code
مثال
3

شناسه گروه

الزامی

cURL مثال

curl -X GET \
  https://salamquran.com/fa/api/v6/lms/level?id=3 \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6'

پاسخ مثال

{
  "ok": true,
  "result": {
    "id": "3",
    "lm_group_id": "3",
    "title": "آموزش نکات روخوانی و روان خوانی",
    "desc": "در این قسمت شما با آموزش نکات روخوانی و روان‌خوانی این سوره آشنا خواهید شد",
    "type": "learn",
    "type_title": "Learn",
    "quranfrom": null,
    "quranto": null,
    "besmellah": null,
    "file": "https://evazzadeh.com/dl/video/chrikt-php01-intro.mp4",
    "setting": null,
    "sort": "2",
    "ratio": "5",
    "unlockscore": null,
    "status": "enable",
    "datecreated": "2019-07-26 16:33:16",
    "questionrandcount": null,
    "filepic": "https://evazzadeh.com/dl/2016/07/php-evazzadeh.png"
  }
}

GET
دریافت امتیازات کاربر در یک مرحله از مکانیزم آموزش

GET https://salamquran.com/fa/api/v6/lms/userstar

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از صفحه اکانت خودتان دریافت شده است

پارامترها

نام نوع توضیح مثال محدودیت‌ها
id
code
مثال
3

شناسه مرحله

الزامی

cURL مثال

curl -X GET \
  https://salamquran.com/fa/api/v6/lms/userstar?id=3 \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6'

پاسخ مثال

{
  "ok": true,
  "result": {
    "star": 3
  }
}

POST
تنظیم امتیاز کاربر در یک مرحله مکانیزم آموزش

POST https://salamquran.com/fa/api/v6/lms/star

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از صفحه اکانت خودتان دریافت شده است

پارامترها

نام نوع توضیح مثال محدودیت‌ها
id
code
مثال
3

شناسه مرحله

الزامی
star
number
مثال
1

تنها اعداد ۱و۲و۳ می‌توانند در امتیاز مورد استفاده قرار گیرند

الزامی

cURL مثال

curl -X POST \
  https://salamquran.com/fa/api/v6/lms/star \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6'\
  -F star=1 \
  -F id=3

پاسخ مثال

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "Hooray!\n⭐️",
      "meta": {
          "alerty": true
      }
    }
  ],
  "result": {
    "id": "3g"
  }
}

POST
ارسال صوت یک کاربر در مکانیزم آموزش

POST https://salamquran.com/fa/api/v6/lms/audio

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از صفحه اکانت خودتان دریافت شده است

پارامترهای الزامی

نام نوع توضیح مثال محدودیت‌ها
id
code
مثال
3

شناسه مرحله

الزامی
audio
FILE
آدرس فایل شما برای آپلود
الزامی

cURL مثال

curl -X POST \
  https://salamquran.com/fa/api/v6/lms/audio \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b' \
  -F audio=@/home/reza/Desktop/yourfile.jpg \
  -F id=3

پاسخ مثال

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "Your audio uploaded"
    }
  ],
  "result": null
}

POST
تنظیم پاسخ کاربر در یک مرحله

POST https://salamquran.com/fa/api/v6/lms/answer

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از صفحه اکانت خودتان دریافت شده است

پارامترهای الزامی

نام نوع توضیح مثال محدودیت‌ها
id
code
مثال
3

شناسه مرحله

الزامی
[question id]
code
1[2,3,4]
شماره گزینه پاسخ داده شده
به تعداد سوالاتی که می‌خواهید پاسخ آن‌ها ذخیره شود تکرار کنید
الزامی

cURL مثال

curl -X POST \
  https://salamquran.com/fa/api/v6/lms/answer \
  -H 'apikey: 87923bd0d04b30aa5f66b699c2698e3b' \
  -F id=3 \
  -F z=1 \
  -F y=2 \
  -F C=1 \
  -F D=3 \
  -F B=4

پاسخ مثال

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "هورا!\n⭐️⭐️⭐️",
      "meta": {
          "alerty": true
      }
    },
    {
      "type": "ok",
      "text": "پاسخ شما ذخیره شد"
    }
  ],
  "result": true
}

GET
دریافت لیست خطاهای آموزشی

GET https://salamquran.com/fa/api/v6/mistake

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از صفحه اکانت خودتان دریافت شده است

cURL مثال

curl -X GET \
  https://salamquran.com/fa/api/v6/mistake \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6'

پاسخ مثال

{
  "ok": true,
  "pagination": {
    "desc": "page 1 of 1 - Show record 1 to 8 of 8",
    "page": 1,
    "total_page": 1,
    "limit": 10,
    "total_rows": 8
  },
  "result": [
    {
      "id": "3",
      "title": "اشباه در خواندن کلمه",
      "datecreated": "2019-07-31 10:20:27"
    },
    {
      "id": "4",
      "title": "اشتباه حرفی و اعرابی",
      "datecreated": "2019-07-31 10:26:06"
    },
    {
      "id": "5",
      "title": "تبدیل حرکات کوتاه به حرکات کشیده و بالعکس",
      "datecreated": "2019-07-31 10:26:19"
    },
    {
      "id": "6",
      "title": "تپق",
      "datecreated": "2019-07-31 10:26:40"
    },
    {
      "id": "7",
      "title": "مکث بیش از حد",
      "datecreated": "2019-07-31 10:26:44"
    },
    {
      "id": "8",
      "title": "عدم تسلط بر قواعد روخوانی - الف وصل",
      "datecreated": "2019-07-31 10:27:09"
    },
    {
      "id": "9",
      "title": "عدم تسلط بر قواعد روخوانی - حروف ناخوانا",
      "datecreated": "2019-07-31 10:27:18"
    },
    {
      "id": "b",
      "title": "عدم تسلط بر قواعد روخوانی - ادغام در حد ضرورت",
      "datecreated": "2019-07-31 10:27:26"
    }
  ]
}

GET
لیست صوت‌های کاربران

GET https://salamquran.com/fa/api/v6/audio

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از صفحه اکانت خودتان دریافت شده است

cURL مثال

curl -X GET \
  https://salamquran.com/fa/api/v6/audio \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6'

پاسخ مثال

{
  "ok": true,
  "pagination": {
    "desc": "page 1 of 2 - Show record 1 to 10 of 18",
    "page": 1,
    "total_page": 2,
    "limit": 10,
    "total_rows": 18
  },
  "result": [
    {
      "id": "p",
      "lm_group_id": "4",
      "lm_level_id": "3",
      "user_id": "4",
      "teacher": "2",
      "audio": "https://salamquran.com/files/1/89-4a9b426f9386c52184a2bd0e54ce325d.wav",
      "teachertxt": "خوب بود",
      "teacheraudio": null,
      "quality": "2",
      "status": "archive",
      "tstatus": "Archive",
      "datecreated": "2019-08-05 13:03:21",
      "group_title": "سوره ناس تا سوره کافرون",
      "level_title": "سوره ناس",
      "user_displayname": "رضا محیطی",
      "teacher_displayname": "رضا محیطی"
    },
    {
      "id": "n",
      "lm_group_id": "4",
      "lm_level_id": "3",
      "user_id": "4",
      "teacher": "2",
      "audio": "https://salamquran.com/files/1/88-4a9b426f9386c52184a2bd0e54ce325d.wav",
      "teachertxt": "عالی بود",
      "teacheraudio": "https://salamquran.com/files/1/90-01d0ec51f28b89f990e54d940c1525cc.jpg",
      "quality": "3",
      "status": "archive",
      "tstatus": "Archive",
      "datecreated": "2019-08-05 13:02:57",
      "group_title": "سوره ناس تا سوره کافرون",
      "level_title": "سوره ناس",
      "user_displayname": "رضا محیطی",
      "teacher_displayname": "رضا محیطی"
    }
  ]
}

POST
ویرایش صوت کاربر

POST https://salamquran.com/fa/api/v6/audio/edit

پارامترهای الزامی روی هدر

نام نوع توضیح مثال محدودیت‌ها
apikey
string
کلید اتصال شما
87923bd0d04b30aa5f66b699c2698e3b
الزامی
طول ۳۲
از صفحه اکانت خودتان دریافت شده است

پارامترهای الزامی

نام نوع توضیح مثال محدودیت‌ها
id
code
مثال
p

شناسه صوت

الزامی
teachertxt
String

پاسخ متنی استاد

teacheraudio
FILE

آدرس فایل شما برای آپلود

status
String
مثال
approved

وضعیت‌های مجاز

['awaiting', 'spam', 'deleted', 'admindelete', 'approved', 'reject', 'archive']
quality
Number
مثال
2

1,2,3

mistake_[mistake id]
String
مثال
mistake_p mistake_2Kf

دریافت از رابط برنامه‌نویسی لیست خطا‌های آموزشی

cURL مثال

curl -X POST \
  https://salamquran.com/fa/api/v6/audio/edit \
  -H 'apikey: 87085dbb44ee1ef51f4fbaeb39eeb0e6' \
  -F id=p \
  -F status=approved

پاسخ مثال

{
  "ok": true,
  "msg": [
    {
      "type": "ok",
      "text": "audio successfully updated"
    }
  ],
  "result": null
}

GET
Get list of qari detail

GET https://salamquran.com/fa/api/v6/qari

cURL مثال

curl -X GET https://salamquran.com/fa/api/v6/qari

پاسخ مثال

{
  "ok": true,
  "result": [
    {
      "index": 1090,
      "lang": "fa",
      "type": "ترتیل",
      "addr": "https://dl.salamquran.com/ayat/parhizgar-murattal-48/",
      "slug": "parhizgar",
      "name": "شهریار پرهیزگار",
      "image": "https://salamquran.local/static/images/qariyan/parhizgar.png",
      "short_name": "پرهیزگار"
    },
    {
      "index": 1091,
      "lang": "fa",
      "type": "ترتیل",
      "addr": "https://dl.salamquran.com/ayat/mansouri-murattal-40/",
      "slug": "mansouri",
      "name": "کریم منصوری",
      "image": "https://salamquran.local/static/images/qariyan/mansouri.png",
      "short_name": "منصوری"
    }
  ]
}
لطفا برای بهرمندی از تجربه مطلوب‌تر از مرورگرهای مطرح استفاده کنید.