مستندات

در این صفحه، آموزش استفاده از API ترجمه فارسی قرآن کریم، برای استفاده همگان قرار داده شده است. با استفاده از این راهنما، میتوانید به سادگی از این API در پروژه های خود استفاده نمایید.

آدرس دسترسی API

این API فی‌الحال روی سرویس های فندق میزبانی شده و از طریق آدرس زیر، در دسترس است :

ptquran-haghiri75.fandogh.cloud

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

روش ارسال درخواست ها

لیست نام سوره ها

GET /suraNames

نام سوره بر اساس ترتیب

GET /surah/:id

مقدار id در اینجا، از ۱ تا ۱۱۴ (تعداد سوره‌های قرآن کریم) می‌تواند باشد.

محل نزول سوره

GET /surah/:id/nozul

متن عربی سوره (کامل)

GET /ar/surah/:sid

متن عربی سوره (یک آیه خاص)

GET /ar/surah/:sid/ayah/:aid

متن فارسی سوره (کامل)

GET /fa/surah/:sid

متن فارسی سوره (یک آیه خاص)

GET /fa/surah/:sid/ayah/:aid

همکاری با پروژه

چنانچه مایل به همکاری با این پروژه هستید، می‌توانید از طریق گیت‌لب اقدام به ارسال Pull Request نمایید.