دریافت اوقات شرعی

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

مشخصات

مشخصه	مقدار
دسته‌بندی	اطلاعات
وضعیت	فعال
نسخه API	apis-1
فرمت پاسخ	JSON
آدرس پایه	https://open.nestapi.ir
مسیر	/apis-1/prayer-times
لینک کامل	https://open.nestapi.ir/apis-1/prayer-times

متدهای HTTP

متد	مسیر	نوع ورودی
GET	/apis-1/prayer-times	Query String

پارامترها

پارامترهای Query String

نام	نوع	الزامی	پیش‌فرض	توضیحات
city	string	بله	—	نام شهر (فارسی یا انگلیسی) یا کد شهر، مثلاً تهران، tehran یا 1
action	string	خیر	—	مقدار cities برای مشاهدهٔ فهرست شهرهای پشتیبانی‌شده
q	string	خیر	—	جستجو در فهرست شهرها هنگام استفاده از action=cities، مثلاً isfahan

نمونه درخواست

لینک مستقیم

GET https://open.nestapi.ir/apis-1/prayer-times?city=tehran

نمونه کد

cURL

curl -X GET "https://open.nestapi.ir/apis-1/prayer-times?city=tehran"

PHP

<?php

// composer require nestapi/nestapi
require 'vendor/autoload.php';

use NestApi\NestApi;
use NestApi\Exception\ApiException;
use NestApi\Exception\TransportException;

$api = new NestApi();

try {
    $response = $api->prayerTimes(city: 'tehran');

    print_r($response->data);
} catch (ApiException $e) {
    // Error reported by the API (validation, not found, rate limit, ...)
    echo $e->getMessage();
} catch (TransportException $e) {
    // Network error or unusable response; not a subclass of ApiException
    echo 'Network error: ' . $e->getMessage();
}

Python

# pip install nestapi-py
from nestapi import ApiError, NestApi, TransportError

with NestApi() as api:
    try:
        response = api.prayer_times(city="tehran")

        print(response.data)
    except ApiError as e:
        # Error reported by the API (validation, not found, rate limit, ...)
        print(e.error_code, e)
    except TransportError as e:
        # Network error or unusable response; not a subclass of ApiError
        print("Network error:", e)

JavaScript

// npm install @devh3n/nestapi
import { ApiError, NestApi, TransportError } from "@devh3n/nestapi";

const api = new NestApi();

try {
  const response = await api.prayerTimes({ city: "tehran" });

  console.log(response.data);
} catch (error) {
  if (error instanceof ApiError) {
    // Error reported by the API (validation, not found, rate limit, ...)
    console.error(error.errorCode, error.message);
  } else if (error instanceof TransportError) {
    // Network error or unusable response; not a subclass of ApiError
    console.error("Network error:", error.message);
  }
}

کدهای خطا

کد	وضعیت	علت
NOT_FOUND	404	مسیر وجود ندارد، یا متد روی آن ثبت نشده
PARAM_NOT_FOUND	400	پارامتر لازم ارسال نشده
VALIDATION_ERROR	422	پارامتر آمده ولی نوع، قالب یا بازه‌اش نادرست است
CITY_NOT_FOUND	404	شهر موردنظر یافت نشد
UPSTREAM_ERROR	502	خطا در پاسخ دریافتی از سرویس بالادستی

لینک های بیشتر

• راهنمای اتصال به سرویس
• فرمت خروجی موفقیت API
• فرمت خروجی خطای API
• کدهای خطای عمومی