API
REST API نسخهدار برای همهٔ اجزای پایهٔ زمان و زمانبندی.
POST /v1/dates/resolve
POST /v1/business-days/add
POST /v1/deadlines
POST /v1/schedules/previewتطبیق تاریخ و تقویم · زیرساخت زمان برای توسعهدهندگان
تاریخهای شمسی، میلادی و قمری را فقط تبدیل نکنید؛ روزها را تطبیق دهید، اختلافها را تشخیص دهید و روز هفته، تعطیلات و روز کاری را با دادهٔ نسخهدار بررسی کنید.
تطبیق تاریخ از API و SDK با شناسهٔ درخواست و نسخهٔ داده؛ برای ساخت و یکپارچهسازی میتوانید همین حالا ثبتنام کنید و پس از تأیید ایمیل، کلید تست ۳۰روزه بگیرید. ویجتهای نمایشی سایت هنوز جایگزین اتصال واقعی API نیستند.
بدون کارت بانکی · ثبتنام مستقیم · کلید تست ۳۰روزه پس از تأیید ایمیل
دکتر امینی، تهران
۱۰:۰۰ انتخاب شد
روی زبانهها بزنید یا عبارت را خودتان بنویسید.
از یک تبدیل تاریخ ساده تا گردشکارهای زماندار در مقیاس واقعی.
چرا به ما بسپارید؟
هر تیمی که برای کاربران ایرانی نرمافزار میسازد، زود با این پرسشهای تکراری روبهرو میشود:
همین نیازهای بهظاهر کوچک، بهمرور به سامانهای پیچیده تبدیل میشوند که به نگهداری مداوم نیاز دارد.
قبل
بعد
زیرساخت زمان
تبدیل تاریخ فقط آغاز کار است. هدف ما ارائهٔ مدلی هماهنگ برای تقویم، روزهای کاری و زمانبندی در محصول شماست.
نمونهتاریخ نمونه۳۰ آبان ۱۴۰۵
نمونهنخستین روز کاری پیش رویکشنبه ۱ آذر ۱۴۰۵
نمونهاجرای بعدی «هر روز کاری، ساعت ۱۸»۱۴۰۵/۰۹/۰۱، ساعت ۱۸:۰۰
روی هر قابلیت بزنید تا نمونهٔ تعاملی آن را ببینید.
یک مدل زمانی و چند رابط؛ بیآنکه منطق زمان در هر محصول از نو نوشته شود.
رابطها
REST API نسخهدار برای همهٔ اجزای پایهٔ زمان و زمانبندی.
POST /v1/dates/resolve
POST /v1/business-days/add
POST /v1/deadlines
POST /v1/schedules/previewنمونهکدهای JavaScript و Python برای شروع فراهماند؛ عرضهٔ SDK رسمی و نسخهدار به تکمیل آزمونها وابسته است.
import { createTestClient } from "@taghvim/sdk";
const client = createTestClient({ apiKey: process.env.TAGHVIM_TEST_API_KEY });
const result = await client.addBusinessDays({date: "1405-07-15", days: 30});
console.log(result.data.result.jalali);رابط خط فرمان در نقشهٔ محصول قرار دارد؛ وضعیت عرضهٔ آن پیش از استفادهٔ عملی اعلام میشود.
taghvim date resolve "سه روز کاری بعد"
taghvim availability find
taghvim sandbox clock advance 3dابزارهای برنامهریزیشده برای عاملهای هوشمند، با اختیار و دامنهٔ دسترسی مشخص.
taghvim_find_availability
taghvim_create_reservation
taghvim_create_deadline
taghvim_create_scheduleاجزای آمادهٔ راستبهچپ با تقویم شمسی، برای جاسازی مستقیم در محصول.
ارسال رویدادهای زمانی با امضا، پیگیری تحویل و تلاش دوباره؛ استفادهٔ عملیاتی به فعالسازی مجاز نیاز دارد.
{
"id": "evtlog_…",
"type": "taghvim.event.reservation.confirmed.v1"
}ویجتها
ویجتها را در همین صفحه امتحان کنید. برای اتصال به محصول خودتان، پس از دریافت دسترسی تأییدشده میتوانید از API استفاده کنید. وضعیت عرضهٔ ویجتهای قابلنصب و SDK جداگانه اعلام میشود.
موتور تقویم
موتور تقویم پایهٔ همهچیز است، نه فقط ابزاری برای قالببندی تاریخ.
نتیجه
۱۴۰۵/۰۷/۱۹، ساعت ۱۰:۰۰
یکشنبه ۱۹ مهر ۱۴۰۵
2026-10-11T10:00:00+03:30[Asia/Tehran]
تبدیل تاریخ میان شمسی، میلادی و قمری (با ارقام فارسی یا لاتین) کار خود موتور تقویم است. موتور هنوز زبان طبیعی فارسی را کامل نمیفهمد؛ این آزمایشگاه فقط این الگوها را روی آن میسازد: «N روز (کاری) بعد/قبل از …»، «امروز/فردا/پسفردا/دیروز» و «ساعت HH:MM». هر عبارت دیگری را صادقانه «نامفهوم» اعلام میکند.
روزهای کاری
وقتی پای قرارداد، پرداخت، SLA، تسویه، حقوق یا مقررات در میان است، شمردن روز کاری دیگر یک تابع کمکی ساده نیست.
روز کاریجمعهتعطیل رسمیسررسید
POST /v1/business-days/add
{
"date": "1405-07-15",
"days": 30
}اکتبر تا نوامبر ۲۰۲۶۲۴ روز کاری، ۱ تعطیل رسمی
| ش | ی | د | س | چ | پ | ج |
|---|---|---|---|---|---|---|
| ۱ | ||||||
| ۲ | ۳ | ۴ | ۵ | ۶ | ۷ | ۸ |
| ۹ | ۱۰ | ۱۱ | ۱۲ | ۱۳ | ۱۴ | ۱۵ |
| ۱۶ | ۱۷ | ۱۸ | ۱۹ | ۲۰ | ۲۱ | ۲۲ |
| ۲۳ | ۲۴ | ۲۵ | ۲۶ | ۲۷ | ۲۸ | ۲۹ |
| ۳۰ |
تعطیل رسمیتعطیلی قمری (پیشبینی)جمعهامروز
دریافت تعطیلات ۱۴۰۵ (فایل ICS) در این ماه تعطیلی رسمی یا مناسبتی ثبت نشده است.موتور زمانبندی
«منبع» میتواند شخص، اتاق، خودرو، دستگاه یا سرویس باشد؛ هر چیزی که برای آن ظرفیت و بازهٔ زمانی تعریف میشود.
آخرین روز کاری هر ماه، ساعت ۰۹:۰۰
شش نوبت بعدی
POST /v1/schedules/preview
{
"rule": "last-business",
"from": "1405-08-30",
"count": 6
}موتور سررسید
سررسید را میشود از یک تاریخ ثابت، یک رویداد، شمار روزهای کاری، سیاست سازمان یا حتی یک سند ورودی حساب کرد.
گردشکارها
هر قدم نسبت به قدمی دیگر تعریف میشود: چند روز کاری پس از تأیید، یا ده روز تقویمی پس از آن. تاریخ شروع، فاصلهها یا قاعدهٔ تعطیلی را تغییر دهید و «اجرا» را بزنید تا موتور تقویم همهٔ قدمها را دوباره بچیند.
POST /v1/workflow-runs/preview
{
"start": "1405-11-12",
"roll": "following",
"steps": [
{
"id": "approve",
"offset": 0,
"unit": "business"
},
{
"id": "due",
"offset": 10,
"unit": "calendar",
"relative_to": "approve"
},
{
"id": "remind",
"offset": -2,
"unit": "business",
"relative_to": "due"
},
{
"id": "settle",
"offset": 1,
"unit": "business",
"relative_to": "due"
}
]
}زمانبندی عاملها و MCP
برای فعالیت زمانبندیشدهٔ عاملهای هوشمند باید بتوان برنامه، سطح دسترسی، سقف مصرف و سابقهٔ اجرا را مشاهده و بررسی کرد.
خودکارسازی با عاملها بدون زمانبندی قابل نظارت، زیرساخت عملیاتی نیست.
دادهٔ نمایشی؛ اجرای بعدی را موتور روز کاری حساب میکند.
یکی از درخواستها را انتخاب کنید تا فراخوانی ابزارها را ببینید.
رویدادها و وبهوکها
هر تغییر مهم زمانی میتواند رویدادی قابلپیگیری ایجاد کند و در صورت فعالبودن اتصال، به سامانهٔ شما اعلام شود.
نمونه؛ زمانها به وقت تهران، از همین لحظه
خط پردازش رویدادها
رویدادها از فرم، API یا وبهوک ورودی میرسند؛ موتور تقویم منطقهٔ زمانی، تعطیلات و روز کاری را بررسی میکند و بعد اعلان، وبهوک یا رویداد تقویم ساخته میشود. یک رویداد بفرستید و مسیرش را دنبال کنید.
گزارش اجرا
نمونه: تصمیمهای زمانی را موتور تقویم میگیرد؛ بار و تأخیر نمایشیاند.
مرکز اعلانها
یادآورها، سررسیدها و تحویل وبهوکها، با تاریخهایی که موتور تقویم حساب میکند. هر دکمه یک اعلان واقعی روی همین صفحه میسازد.
اعلانها واقعیاند؛ متن و شمارهها نمونهاند.
پیشنمایش روی گوشی
جستوجو، شواهد و رسیدها
ثبت رسید، سابقه و شواهد برای عملیات حساس در طراحی پیشبینی شده است؛ فعالبودن آن باید در محیط واقعی تأیید شود.
سررسیدهای فعال قراردادها در این هفته
فیلترها
سابقهی رویدادهای یک رزرو
taghvim.event.reservation.held.v1taghvim.event.reservation.confirmed.v1taghvim.event.receipt.issued.v1taghvim.event.reminder.scheduled.v1taghvim.event.webhook.delivered.v1usr_123booking-v3doctor_1evtlog_7f3a…rcpt_92c1…یکپارچهسازی
مدل زمانی مشترک، مبنای اتصال سامانههای مختلف است؛ هر اتصالدهنده باید جداگانه آزموده و تأیید شود.
خروجی یکطرفه؛ فایل تعطیلات ۱۴۰۵ همین حالا با موتور تقویم ساخته شده و دریافتشدنی است.
اتصالدهندهها، بستههای تقویم، گردشکارها و ویجتهای بیشتر از بازارچه نصب میشوند؛ اما برای شروع به بازارچه نیازی نیست.
یکبار بسازید
POST /v1/business-days/add
{ "date": "1405-08-30", "days": 3 }همه یک پاسخ میگیرند: سهشنبه ۳ آذر ۱۴۰۵
API، MCP و ویجت سه محصول جدا نیستند؛ سه رابط روی یک موتورند. برای همین رفتار و معنای هر عملیات همهجا یکسان است.
شروع برای توسعهدهندگان
Project: my-app
Environment: sandbox
Locale: fa-IR
Timezone: Asia/Tehranexport TAGHVIM_API_KEY=tgv_test_...curl https://api.taghvim.dev/v1/dates/resolve \
-H "Authorization: Bearer $TAGHVIM_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"text":"سه روز کاری بعد",
"locale":"fa-IR"
}'{
"status": "resolved",
"jalali": "1405-09-03",
"business_day": true
}پاسخ نمونه؛ تاریخها هنگام اجرای ابزارهای تعاملی دوباره محاسبه میشوند.
import { createTestClient } from "@taghvim/sdk"; // Server-side code: the trial API key never enters a browser bundle.const client = createTestClient({ apiKey: process.env.TAGHVIM_TEST_API_KEY }); // 30 business days after today, Iranian bank calendarconst due = await client.addBusinessDays({ date: "1405-08-30", days: 30,});console.log(due.data.result.jalali);ثبتنام رایگان و مستقیم از طریق API عمومی است: ایمیل خود را تأیید کنید تا برای Tenant مستقل محیط تست، کلید API آزمایشی ۳۰روزه دریافت کنید. کلید فقط برای محیط تست است و پرداختی انجام نمیشود.
مرجع تعاملی API
مشخصات هر عملیات و نمونهکد آن را ببینید. نمونههای تقویم در مرورگر اجرا میشوند؛ درخواستهای محافظتشده فقط با کلید معتبرِ صادرشده قابل آزمایشاند.
نشانی سرویس: https://api.taghvim.dev · احراز هویت: Authorization: Bearer tgv_test_…
/v1/healthسلامت سرویسبدون کلیدHealthinternal_errorخطای پیشبینینشدهای رخ داد.وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/health" \
-H "Accept: application/json"const res = await fetch("https://api.taghvim.dev/v1/health", {
method: "GET",
headers: {
Accept: "application/json",
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/health",
headers={"Accept": "application/json"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/readinessآمادگی سرویسبدون کلیدReadinessinternal_errorخطای پیشبینینشدهای رخ داد.Readinessوضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/readiness" \
-H "Accept: application/json"const res = await fetch("https://api.taghvim.dev/v1/readiness", {
method: "GET",
headers: {
Accept: "application/json",
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/readiness",
headers={"Accept": "application/json"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/versionsنسخههابدون کلیدVersionsinternal_errorخطای پیشبینینشدهای رخ داد.وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/versions" \
-H "Accept: application/json"const res = await fetch("https://api.taghvim.dev/v1/versions", {
method: "GET",
headers: {
Accept: "application/json",
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/versions",
headers={"Accept": "application/json"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/openapi.jsonهمین سند OpenAPIبدون کلیدinternal_errorخطای پیشبینینشدهای رخ داد.وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/openapi.json" \
-H "Accept: application/json"const res = await fetch("https://api.taghvim.dev/openapi.json", {
method: "GET",
headers: {
Accept: "application/json",
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/openapi.json",
headers={"Accept": "application/json"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/calendars/systemsتقویمهای پشتیبانیشدهاجرا در مرورگرCalendarSystemskey_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: ۲۰۰ Taghvim-Request-Id: req_example
{
"systems": [
{
"id": "jalali",
"name": "Solar Hijri (Jalali)",
"name_fa": "هجری شمسی",
"year_range": [
1300,
1499
]
},
{
"id": "gregorian",
"name": "Gregorian",
"name_fa": "میلادی",
"year_range": [
1921,
2121
]
},
{
"id": "hijri",
"name": "Hijri (Umm al-Qura)",
"name_fa": "هجری قمری (امالقری)",
"year_range": [
1343,
1500
],
"note": "Lunar holidays are predicted until officially announced."
}
],
"business_day_profile": {
"id": "bank",
"weekend": [
5
],
"description_fa": "تقویم بانکی ایران: جمعه و تعطیلات رسمی، روز غیرکاری هستند."
},
"timezone": "Asia/Tehran",
"calendar_data_version": "iran-2026.10.01"
}curl "https://api.taghvim.dev/v1/calendars/systems" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/calendars/systems", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/calendars/systems",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/dates/convertتبدیل تاریخاجرا در مرورگریک تاریخ شمسی، میلادی یا قمری را میگیرد و همان روز را در هر سه تقویم، همراه با وضعیت روز کاری، برمیگرداند.
| نام | نوع | الزام | توضیح |
|---|---|---|---|
date | DateInput | الزامی | |
calendar_system | object | اختیاری | مقدارها: jalali، gregorian، hijri |
ConvertResponseinvalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.invalid_dateتاریخ واردشده تاریخ شمسی، میلادی یا قمری معتبری نیست.out_of_rangeمقدار واردشده بیرون از بازهی پشتیبانیشده است.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: ۲۰۰ Taghvim-Request-Id: req_example
{
"input": {
"text": "1405-07-15",
"calendar_system": "jalali"
},
"date": {
"iso": "2026-10-07",
"jalali": "1405-07-15",
"hijri": "1448-04-26",
"weekday": 3,
"weekday_fa": "چهارشنبه",
"jalali_text_fa": "۱۵ مهر ۱۴۰۵",
"business_day": true,
"holidays": [],
"predicted_holiday": false
},
"leap_year": false,
"calendar_data_version": "iran-2026.10.01"
}curl -X POST "https://api.taghvim.dev/v1/dates/convert" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Content-Type: application/json" \
-d '{"date":"1405-07-15"}'const res = await fetch("https://api.taghvim.dev/v1/dates/convert", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"date": "1405-07-15"
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.post(
"https://api.taghvim.dev/v1/dates/convert",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
json={"date": "1405-07-15"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/dates/reconcileتطبیق مستند تاریخها بین تقویمهانیازمند کلید APIتاریخهای صریح شمسی، میلادی یا قمری را با موتور واحد به روز تقویمی معادل تبدیل میکند؛ اختلاف روز، روز هفته، روز کاری، تعطیلی احتمالی و مغایرت با ادعاهای ورودی را با نسخهٔ داده و شناسهٔ درخواست گزارش میدهد. این عملیات تطبیق لحظهٔ زمانی یا تعطیلات دیگر کشورها نیست.
| نام | نوع | الزام | توضیح |
|---|---|---|---|
left | ReconcileDateAssertion | الزامی | |
left.date | DateInput | الزامی | |
left.calendar_system | object | الزامی | مقدارها: jalali، gregorian، hijri |
left.expected | object | اختیاری | |
left.expected.iso | string | اختیاری | |
left.expected.weekday | integer | اختیاری | بازه: ۱…۷ |
left.expected.business_day | boolean | اختیاری | |
left.expected.calendar_data_version | string | اختیاری | |
right | ReconcileDateAssertion | الزامی | |
right.date | DateInput | الزامی | |
right.calendar_system | object | الزامی | مقدارها: jalali، gregorian، hijri |
right.expected | object | اختیاری | |
right.expected.iso | string | اختیاری | |
right.expected.weekday | integer | اختیاری | بازه: ۱…۷ |
right.expected.business_day | boolean | اختیاری | |
right.expected.calendar_data_version | string | اختیاری |
ReconcileResponseinvalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.invalid_dateتاریخ واردشده تاریخ شمسی، میلادی یا قمری معتبری نیست.out_of_rangeمقدار واردشده بیرون از بازهی پشتیبانیشده است.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X POST "https://api.taghvim.dev/v1/dates/reconcile" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Content-Type: application/json" \
-d '{"left":{"date":"1405-07-15","calendar_system":"jalali"},"right":{"date":"2026-10-07","calendar_system":"gregorian"}}'const res = await fetch("https://api.taghvim.dev/v1/dates/reconcile", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"left": {
"date": "1405-07-15",
"calendar_system": "jalali"
},
"right": {
"date": "2026-10-07",
"calendar_system": "gregorian"
}
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.post(
"https://api.taghvim.dev/v1/dates/reconcile",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
json={"left": {"date": "1405-07-15", "calendar_system": "jalali"}, "right": {"date": "2026-10-07", "calendar_system": "gregorian"}},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/dates/resolveخواندن تاریخ از متن فارسیاجرا در مرورگرتاریخ صریح (مانند «۱۵ مهر ۱۴۰۵») یا عبارت نسبی فارسی (مانند «سه روز کاری بعد از ۱۵ مهر ساعت ۱۰»، «فردا» یا «۵ روز قبل») را با روزهای کاری تقویم بانکی به تاریخ دقیق تبدیل میکند و مراحل و فرضها را نشان میدهد. عبارتی را که بدون حدس قابل خواندن نباشد، رد میکند.
| نام | نوع | الزام | توضیح |
|---|---|---|---|
text | string | الزامی | |
locale | object | اختیاری | پیشفرض: "fa-IR" |
timezone | object | اختیاری | پیشفرض: "Asia/Tehran" |
calendar_system | object | اختیاری | پیشفرض: "jalali" |
reference_instant | string | اختیاری | |
ambiguity_policy | AmbiguityPolicy | اختیاری | مقدارها: assume_and_report، return_candidates، reject |
ResolveResponseinvalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.unresolved_expressionاین عبارت بدون حدسزدن به تاریخ تبدیل نشد.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: ۲۰۰ Taghvim-Request-Id: req_example
{
"resolution_id": "resolv_01M7Y77M9REWEYD4YFDBBMVV7Y",
"status": "ambiguous",
"normalized_expression": {
"type": "business_day_offset",
"anchor": {
"kind": "explicit_date",
"calendar_system": "jalali"
},
"offset_business_days": 3,
"local_time": "10:00:00"
},
"resolved": {
"instant": "2026-10-11T06:30:00.000Z",
"timezone": "Asia/Tehran",
"jalali": "1405-07-19 10:00",
"gregorian": "2026-10-11 10:00"
},
"confidence": 0.9,
"jalali": "1405-07-19",
"iso": "2026-10-11",
"time": "10:00",
"timezone": "Asia/Tehran",
"date": {
"iso": "2026-10-11",
"jalali": "1405-07-19",
"hijri": "1448-04-30",
"weekday": 7,
"weekday_fa": "یکشنبه",
"jalali_text_fa": "۱۹ مهر ۱۴۰۵",
"business_day": true,
"holidays": [],
"predicted_holiday": false
},
"business_day": true,
"depends_on_predicted_holiday": false,
"assumptions": [
{
"kind": "year",
"value": "1405"
}
],
"candidates": [
{
"jalali": "1405-07-19",
"iso": "2026-10-11",
"time": "10:00",
"resolved": {
"instant": "2026-10-11T06:30:00.000Z",
"timezone": "Asia/Tehran",
"jalali": "1405-07-19 10:00",
"gregorian": "2026-10-11 10:00"
},
"assumptions": [
{
"kind": "year",
"value": "1405"
}
],
"business_day": true
},
{
"jalali": "1406-07-19",
"iso": "2027-10-11",
"time": "10:00",
"resolved": {
"instant": "2027-10-11T06:30:00.000Z",
"timezone": "Asia/Tehran",
"jalali": "1406-07-19 10:00",
"gregorian": "2027-10-11 10:00"
},
"assumptions": [
{
"kind": "year",
"value": "1406"
}
],
"business_day": true
}
],
"ambiguity_policy": "return_candidates",
"reference_instant": "2026-09-29T20:00:00.000Z",
"steps": [
{
"step": "متن ورودی",
"value": "سه روز کاری بعد از 15 مهر ساعت 10"
},
{
"step": "ساعت",
"value": "۱۰:۰۰"
},
{
"step": "تعداد روز",
"value": "۳"
},
{
"step": "نوع روز",
"value": "روز کاری"
},
{
"step": "جهت",
"value": "بعد"
},
{
"step": "مبنا",
"value": "شمسی"
},
{
"step": "تقویم کاری",
"value": "بانکی"
},
{
"step": "فرض",
"value": "سال ۱۴۰۵ (سال جاری)"
},
{
"step": "تاریخ شمسی",
"value": "۱۹ مهر ۱۴۰۵"
},
{
"step": "روز هفته",
"value": "یکشنبه"
}
],
"calendar_data_version": "iran-2026.10.01"
}curl -X POST "https://api.taghvim.dev/v1/dates/resolve" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Content-Type: application/json" \
-d '{"text":"سه روز کاری بعد از ۱۵ مهر ساعت ۱۰","locale":"fa-IR","calendar_system":"jalali","timezone":"Asia/Tehran","reference_instant":"2026-09-29T20:00:00Z","ambiguity_policy":"return_candidates"}'const res = await fetch("https://api.taghvim.dev/v1/dates/resolve", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"text": "سه روز کاری بعد از ۱۵ مهر ساعت ۱۰",
"locale": "fa-IR",
"calendar_system": "jalali",
"timezone": "Asia/Tehran",
"reference_instant": "2026-09-29T20:00:00Z",
"ambiguity_policy": "return_candidates"
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.post(
"https://api.taghvim.dev/v1/dates/resolve",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
json={"text": "سه روز کاری بعد از ۱۵ مهر ساعت ۱۰", "locale": "fa-IR", "calendar_system": "jalali", "timezone": "Asia/Tehran", "reference_instant": "2026-09-29T20:00:00Z", "ambiguity_policy": "return_candidates"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/business-days/addافزودن روز کاریاجرا در مرورگرچند روز کاری به یک تاریخ اضافه یا از آن کم میکند؛ جمعهها و تعطیلات رسمی شمرده نمیشوند.
| نام | نوع | الزام | توضیح |
|---|---|---|---|
date | DateInput | الزامی | |
days | integer | الزامی | بازه: -۳۶۵۰…۳۶۵۰ |
BusinessDaysAddResponseinvalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.invalid_dateتاریخ واردشده تاریخ شمسی، میلادی یا قمری معتبری نیست.out_of_rangeمقدار واردشده بیرون از بازهی پشتیبانیشده است.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: ۲۰۰ Taghvim-Request-Id: req_example
{
"from": {
"iso": "2026-10-07",
"jalali": "1405-07-15",
"hijri": "1448-04-26",
"weekday": 3,
"weekday_fa": "چهارشنبه",
"jalali_text_fa": "۱۵ مهر ۱۴۰۵",
"business_day": true,
"holidays": [],
"predicted_holiday": false
},
"days": 30,
"result": {
"iso": "2026-11-11",
"jalali": "1405-08-20",
"hijri": "1448-06-01",
"weekday": 3,
"weekday_fa": "چهارشنبه",
"jalali_text_fa": "۲۰ آبان ۱۴۰۵",
"business_day": true,
"holidays": [],
"predicted_holiday": false
},
"calendar_days": 35,
"depends_on_predicted_holiday": false,
"calendar_data_version": "iran-2026.10.01"
}curl -X POST "https://api.taghvim.dev/v1/business-days/add" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Content-Type: application/json" \
-d '{"date":"1405-07-15","days":30}'const res = await fetch("https://api.taghvim.dev/v1/business-days/add", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"date": "1405-07-15",
"days": 30
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.post(
"https://api.taghvim.dev/v1/business-days/add",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
json={"date": "1405-07-15", "days": 30},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/business-days/diffشمارش روزهای کاری میان دو تاریخاجرا در مرورگرروزهای کاری و روزهای تعطیل میان دو تاریخ را میشمارد (روز آغاز شمرده نمیشود، روز پایان شمرده میشود).
| نام | نوع | الزام | توضیح |
|---|---|---|---|
from | DateInput | الزامی | |
to | DateInput | الزامی |
BusinessDaysDiffResponseinvalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.invalid_dateتاریخ واردشده تاریخ شمسی، میلادی یا قمری معتبری نیست.out_of_rangeمقدار واردشده بیرون از بازهی پشتیبانیشده است.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: ۲۰۰ Taghvim-Request-Id: req_example
{
"from": {
"iso": "2026-10-07",
"jalali": "1405-07-15"
},
"to": {
"iso": "2026-11-06",
"jalali": "1405-08-15"
},
"calendar_days": 30,
"business_days": 25,
"days_off": [
{
"jalali": "1405-07-17",
"iso": "2026-10-09",
"reason": "weekend",
"titles": []
},
{
"jalali": "1405-07-24",
"iso": "2026-10-16",
"reason": "weekend",
"titles": []
},
{
"jalali": "1405-08-01",
"iso": "2026-10-23",
"reason": "weekend",
"titles": []
},
{
"jalali": "1405-08-08",
"iso": "2026-10-30",
"reason": "weekend",
"titles": []
},
{
"jalali": "1405-08-15",
"iso": "2026-11-06",
"reason": "weekend",
"titles": []
}
],
"depends_on_predicted_holiday": false,
"calendar_data_version": "iran-2026.10.01"
}curl -X POST "https://api.taghvim.dev/v1/business-days/diff" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Content-Type: application/json" \
-d '{"from":"1405-07-15","to":"1405-08-15"}'const res = await fetch("https://api.taghvim.dev/v1/business-days/diff", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"from": "1405-07-15",
"to": "1405-08-15"
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.post(
"https://api.taghvim.dev/v1/business-days/diff",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
json={"from": "1405-07-15", "to": "1405-08-15"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/business-days/is-business-dayآیا این روز کاری است؟اجرا در مرورگر| نام | نوع | الزام | توضیح |
|---|---|---|---|
date | DateInput | الزامی |
BusinessDayStatusinvalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.invalid_dateتاریخ واردشده تاریخ شمسی، میلادی یا قمری معتبری نیست.out_of_rangeمقدار واردشده بیرون از بازهی پشتیبانیشده است.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: ۲۰۰ Taghvim-Request-Id: req_example
{
"date": {
"iso": "2026-10-07",
"jalali": "1405-07-15",
"hijri": "1448-04-26",
"weekday": 3,
"weekday_fa": "چهارشنبه",
"jalali_text_fa": "۱۵ مهر ۱۴۰۵",
"business_day": true,
"holidays": [],
"predicted_holiday": false
},
"business_day": true,
"reason": null,
"predicted": false,
"previous_business_day": {
"iso": "2026-10-06",
"jalali": "1405-07-14"
},
"next_business_day": {
"iso": "2026-10-08",
"jalali": "1405-07-16"
},
"calendar_data_version": "iran-2026.10.01"
}curl -X POST "https://api.taghvim.dev/v1/business-days/is-business-day" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Content-Type: application/json" \
-d '{"date":"1405-07-15"}'const res = await fetch("https://api.taghvim.dev/v1/business-days/is-business-day", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"date": "1405-07-15"
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.post(
"https://api.taghvim.dev/v1/business-days/is-business-day",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
json={"date": "1405-07-15"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/business-days/checkآیا این روز کاری است؟ (با پارامتر)اجرا در مرورگر| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
date | پرسوجو | DateInput | الزامی |
BusinessDayStatusvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.invalid_dateتاریخ واردشده تاریخ شمسی، میلادی یا قمری معتبری نیست.out_of_rangeمقدار واردشده بیرون از بازهی پشتیبانیشده است.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: ۲۰۰ Taghvim-Request-Id: req_example
{
"date": {
"iso": "2026-10-07",
"jalali": "1405-07-15",
"hijri": "1448-04-26",
"weekday": 3,
"weekday_fa": "چهارشنبه",
"jalali_text_fa": "۱۵ مهر ۱۴۰۵",
"business_day": true,
"holidays": [],
"predicted_holiday": false
},
"business_day": true,
"reason": null,
"predicted": false,
"previous_business_day": {
"iso": "2026-10-06",
"jalali": "1405-07-14"
},
"next_business_day": {
"iso": "2026-10-08",
"jalali": "1405-07-16"
},
"calendar_data_version": "iran-2026.10.01"
}curl "https://api.taghvim.dev/v1/business-days/check?date=1405-07-15" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/business-days/check?date=1405-07-15", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/business-days/check",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
params={"date": "1405-07-15"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/business-days/nextروز کاری بعدیاجرا در مرورگر| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
date | پرسوجو | DateInput | الزامی |
AdjacentBusinessDayvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.invalid_dateتاریخ واردشده تاریخ شمسی، میلادی یا قمری معتبری نیست.out_of_rangeمقدار واردشده بیرون از بازهی پشتیبانیشده است.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: ۲۰۰ Taghvim-Request-Id: req_example
{
"from": {
"iso": "2027-02-10",
"jalali": "1405-11-21"
},
"direction": "next",
"result": {
"iso": "2027-02-13",
"jalali": "1405-11-24",
"hijri": "1448-09-06",
"weekday": 6,
"weekday_fa": "شنبه",
"jalali_text_fa": "۲۴ بهمن ۱۴۰۵",
"business_day": true,
"holidays": [],
"predicted_holiday": false
},
"calendar_days": 3,
"calendar_data_version": "iran-2026.10.01"
}curl "https://api.taghvim.dev/v1/business-days/next?date=1405-11-21" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/business-days/next?date=1405-11-21", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/business-days/next",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
params={"date": "1405-11-21"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/business-days/previousروز کاری قبلیاجرا در مرورگر| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
date | پرسوجو | DateInput | الزامی |
AdjacentBusinessDayvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.invalid_dateتاریخ واردشده تاریخ شمسی، میلادی یا قمری معتبری نیست.out_of_rangeمقدار واردشده بیرون از بازهی پشتیبانیشده است.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: ۲۰۰ Taghvim-Request-Id: req_example
{
"from": {
"iso": "2027-02-13",
"jalali": "1405-11-24"
},
"direction": "previous",
"result": {
"iso": "2027-02-10",
"jalali": "1405-11-21",
"hijri": "1448-09-03",
"weekday": 3,
"weekday_fa": "چهارشنبه",
"jalali_text_fa": "۲۱ بهمن ۱۴۰۵",
"business_day": true,
"holidays": [],
"predicted_holiday": false
},
"calendar_days": -3,
"calendar_data_version": "iran-2026.10.01"
}curl "https://api.taghvim.dev/v1/business-days/previous?date=1405-11-24" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/business-days/previous?date=1405-11-24", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/business-days/previous",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
params={"date": "1405-11-24"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/holidaysتعطیلات رسمی یک سال یا ماه شمسیاجرا در مرورگرتعطیلات قمری تا اعلام رسمی «پیشبینی» هستند و ممکن است یک روز جابهجا شوند.
| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
year | پرسوجو | integer | الزامی | |
month | پرسوجو | integer | اختیاری |
HolidayListvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.out_of_rangeمقدار واردشده بیرون از بازهی پشتیبانیشده است.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: ۲۰۰ Taghvim-Request-Id: req_example
{
"year": 1405,
"month": 11,
"count": 2,
"holidays": [
{
"jalali": "1405-11-04",
"iso": "2027-01-24",
"title": "ولادت حضرت قائم",
"kind": "lunar",
"status": "predicted"
},
{
"jalali": "1405-11-22",
"iso": "2027-02-11",
"title": "پیروزی انقلاب اسلامی",
"kind": "solar",
"status": "official"
}
],
"calendar_data_version": "iran-2026.10.01"
}curl "https://api.taghvim.dev/v1/holidays?year=1405&month=11" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/holidays?year=1405&month=11", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/holidays",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
params={"year": 1405, "month": 11},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/holidays/{date}تعطیلات یک روزاجرا در مرورگر| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
date | مسیر | DateInput | الزامی |
HolidayDayvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.invalid_dateتاریخ واردشده تاریخ شمسی، میلادی یا قمری معتبری نیست.out_of_rangeمقدار واردشده بیرون از بازهی پشتیبانیشده است.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: ۲۰۰ Taghvim-Request-Id: req_example
{
"date": {
"iso": "2027-02-11",
"jalali": "1405-11-22",
"hijri": "1448-09-04",
"weekday": 4,
"weekday_fa": "پنجشنبه",
"jalali_text_fa": "۲۲ بهمن ۱۴۰۵",
"business_day": false,
"holidays": [
"پیروزی انقلاب اسلامی"
],
"predicted_holiday": false
},
"holiday": true,
"holidays": [
{
"jalali": "1405-11-22",
"iso": "2027-02-11",
"title": "پیروزی انقلاب اسلامی",
"kind": "solar",
"status": "official"
}
],
"calendar_data_version": "iran-2026.10.01"
}curl "https://api.taghvim.dev/v1/holidays/1405-11-22" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/holidays/1405-11-22", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/holidays/1405-11-22",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/deadlinesساختن سررسیداجرا در مرورگرسررسیدی بر پایهی تاریخ مبنا، تعداد روز (کاری یا تقویمی) و قاعدهی جابهجایی در روز تعطیل میسازد و نگه میدارد.
| نام | نوع | الزام | توضیح |
|---|---|---|---|
anchor | DateInput | الزامی | |
days | integer | الزامی | بازه: ۰…۳۶۵۰ |
type | object | اختیاری | مقدارها: business، calendar؛ پیشفرض: "business" |
roll | Roll | اختیاری | مقدارها: following، modified_following، preceding، modified_preceding، nearest، none |
title | string | اختیاری | |
subject_ref | string | اختیاری |
Deadlineinvalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.invalid_dateتاریخ واردشده تاریخ شمسی، میلادی یا قمری معتبری نیست.out_of_rangeمقدار واردشده بیرون از بازهی پشتیبانیشده است.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: ۲۰۱ Taghvim-Request-Id: req_example
{
"id": "ddl_01M7Y77M9RCHSB2EG3DJG32AXY",
"status": "active",
"title": null,
"subject_ref": null,
"anchor": {
"iso": "2026-10-07",
"jalali": "1405-07-15",
"hijri": "1448-04-26",
"weekday": 3,
"weekday_fa": "چهارشنبه",
"jalali_text_fa": "۱۵ مهر ۱۴۰۵",
"business_day": true,
"holidays": [],
"predicted_holiday": false
},
"rule": {
"days": 10,
"type": "business",
"roll": "following"
},
"due": {
"iso": "2026-10-19",
"jalali": "1405-07-27",
"hijri": "1448-05-08",
"weekday": 1,
"weekday_fa": "دوشنبه",
"jalali_text_fa": "۲۷ مهر ۱۴۰۵",
"business_day": true,
"holidays": [],
"predicted_holiday": false
},
"moved_days": 0,
"depends_on_predicted_holiday": false,
"created_at": {
"iso": "2026-11-21T04:53:31.064Z",
"local": "2026-11-21T08:23:31+03:30",
"jalali": "1405-08-30 08:23:31",
"timezone": "Asia/Tehran"
},
"calendar_data_version": "iran-2026.10.01"
}curl -X POST "https://api.taghvim.dev/v1/deadlines" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"anchor":"1405-07-15","days":10,"type":"business"}'const res = await fetch("https://api.taghvim.dev/v1/deadlines", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
"anchor": "1405-07-15",
"days": 10,
"type": "business"
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.post(
"https://api.taghvim.dev/v1/deadlines",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={"anchor": "1405-07-15", "days": 10, "type": "business"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/deadlines/{id}دریافت سررسیداجرا در مرورگر| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
id | مسیر | string | الزامی |
Deadlinevalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.not_foundمنبع خواستهشده پیدا نشد.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/deadlines/{id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/deadlines/{id}", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/deadlines/{id}",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/sla/dueمهلت بر حسب ساعت کاریاجرا در مرورگرپایان یک مهلت را با شمردن فقط ساعتهای کاری حساب میکند؛ روزهای تعطیل و ساعتهای بیرون از وقت اداری شمرده نمیشوند.
| نام | نوع | الزام | توضیح |
|---|---|---|---|
start | DateInput | الزامی | |
time | string | اختیاری | پیشفرض: "09:00" |
hours | number | الزامی | بازه: ……۲۰۰۰ |
open | string | اختیاری | پیشفرض: "08:00" |
close | string | اختیاری | پیشفرض: "16:00" |
thursday_close | string | null | اختیاری |
SlaResponseinvalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.invalid_dateتاریخ واردشده تاریخ شمسی، میلادی یا قمری معتبری نیست.invalid_timeساعت واردشده معتبر نیست.out_of_rangeمقدار واردشده بیرون از بازهی پشتیبانیشده است.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: ۲۰۰ Taghvim-Request-Id: req_example
{
"start": {
"iso": "2026-10-07T11:30:00.000Z",
"local": "2026-10-07T15:00:00+03:30",
"jalali": "1405-07-15 15:00:00",
"timezone": "Asia/Tehran"
},
"hours": 24,
"due": {
"iso": "2026-10-12T06:30:00.000Z",
"local": "2026-10-12T10:00:00+03:30",
"jalali": "1405-07-20 10:00:00",
"timezone": "Asia/Tehran"
},
"calendar_days": 5,
"timezone": "Asia/Tehran",
"calendar_data_version": "iran-2026.10.01"
}curl -X POST "https://api.taghvim.dev/v1/sla/due" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Content-Type: application/json" \
-d '{"start":"1405-07-15","time":"15:00","hours":24,"open":"08:00","close":"16:00","thursday_close":"13:00"}'const res = await fetch("https://api.taghvim.dev/v1/sla/due", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"start": "1405-07-15",
"time": "15:00",
"hours": 24,
"open": "08:00",
"close": "16:00",
"thursday_close": "13:00"
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.post(
"https://api.taghvim.dev/v1/sla/due",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
json={"start": "1405-07-15", "time": "15:00", "hours": 24, "open": "08:00", "close": "16:00", "thursday_close": "13:00"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/reminders/previewپیشنمایش یادآورهااجرا در مرورگرزمان یادآورها را پیش از سررسید حساب میکند؛ یادآوری که به روز تعطیل بخورد به روز کاری قبل میرود.
| نام | نوع | الزام | توضیح |
|---|---|---|---|
due | DateInput | الزامی | |
time | string | اختیاری | پیشفرض: "09:00" |
offsets | object[] | الزامی | |
offsets[].n | integer | الزامی | بازه: ۰…۳۶۵ |
offsets[].unit | object | الزامی | مقدارها: business، calendar |
RemindersResponseinvalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.invalid_dateتاریخ واردشده تاریخ شمسی، میلادی یا قمری معتبری نیست.invalid_timeساعت واردشده معتبر نیست.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: ۲۰۰ Taghvim-Request-Id: req_example
{
"due": {
"iso": "2026-11-11",
"jalali": "1405-08-20"
},
"reminders": [
{
"offset": {
"n": 7,
"unit": "calendar"
},
"at": {
"iso": "2026-11-04T05:30:00.000Z",
"local": "2026-11-04T09:00:00+03:30",
"jalali": "1405-08-13 09:00:00",
"timezone": "Asia/Tehran"
},
"moved_days": 0,
"depends_on_predicted_holiday": false
},
{
"offset": {
"n": 3,
"unit": "business"
},
"at": {
"iso": "2026-11-08T05:30:00.000Z",
"local": "2026-11-08T09:00:00+03:30",
"jalali": "1405-08-17 09:00:00",
"timezone": "Asia/Tehran"
},
"moved_days": 0,
"depends_on_predicted_holiday": false
},
{
"offset": {
"n": 0,
"unit": "calendar"
},
"at": {
"iso": "2026-11-11T05:30:00.000Z",
"local": "2026-11-11T09:00:00+03:30",
"jalali": "1405-08-20 09:00:00",
"timezone": "Asia/Tehran"
},
"moved_days": 0,
"depends_on_predicted_holiday": false
}
],
"calendar_data_version": "iran-2026.10.01"
}curl -X POST "https://api.taghvim.dev/v1/reminders/preview" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Content-Type: application/json" \
-d '{"due":"1405-08-20","time":"09:00","offsets":[{"n":7,"unit":"calendar"},{"n":3,"unit":"business"},{"n":0,"unit":"calendar"}]}'const res = await fetch("https://api.taghvim.dev/v1/reminders/preview", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"due": "1405-08-20",
"time": "09:00",
"offsets": [
{
"n": 7,
"unit": "calendar"
},
{
"n": 3,
"unit": "business"
},
{
"n": 0,
"unit": "calendar"
}
]
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.post(
"https://api.taghvim.dev/v1/reminders/preview",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
json={"due": "1405-08-20", "time": "09:00", "offsets": [{"n": 7, "unit": "calendar"}, {"n": 3, "unit": "business"}, {"n": 0, "unit": "calendar"}]},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/schedules/previewنوبتهای بعدی یک قاعدهی تکراراجرا در مرورگرنوبتهای بعدی یک قاعدهی تکرار را حساب میکند؛ مثلاً «آخرین روز کاری هر ماه».
| نام | نوع | الزام | توضیح |
|---|---|---|---|
rule | object | الزامی | مقدارها: last-business، first-business، day-of-month، weekly، every-business |
from | DateInput | الزامی | |
count | integer | اختیاری | پیشفرض: 6؛ بازه: ۱…۲۴ |
day | integer | اختیاری | بازه: ۱…۳۱ |
weekday | integer | اختیاری | بازه: ۱…۷ |
roll | object | اختیاری | مقدارها: following، preceding، skip؛ پیشفرض: "following" |
SchedulePreviewinvalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.invalid_dateتاریخ واردشده تاریخ شمسی، میلادی یا قمری معتبری نیست.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: ۲۰۰ Taghvim-Request-Id: req_example
{
"rule": "last-business",
"rule_fa": "آخرین روز کاری هر ماه",
"from": {
"iso": "2026-09-23",
"jalali": "1405-07-01"
},
"occurrences": [
{
"jalali": "1405-07-30",
"iso": "2026-10-22",
"scheduled_iso": "2026-10-22",
"moved_days": 0,
"depends_on_predicted_holiday": false
},
{
"jalali": "1405-08-30",
"iso": "2026-11-21",
"scheduled_iso": "2026-11-21",
"moved_days": 0,
"depends_on_predicted_holiday": false
},
{
"jalali": "1405-09-30",
"iso": "2026-12-21",
"scheduled_iso": "2026-12-21",
"moved_days": 0,
"depends_on_predicted_holiday": false
},
{
"jalali": "1405-10-30",
"iso": "2027-01-20",
"scheduled_iso": "2027-01-20",
"moved_days": 0,
"depends_on_predicted_holiday": false
}
],
"calendar_data_version": "iran-2026.10.01"
}curl -X POST "https://api.taghvim.dev/v1/schedules/preview" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Content-Type: application/json" \
-d '{"rule":"last-business","from":"1405-07-01","count":4}'const res = await fetch("https://api.taghvim.dev/v1/schedules/preview", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"rule": "last-business",
"from": "1405-07-01",
"count": 4
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.post(
"https://api.taghvim.dev/v1/schedules/preview",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
json={"rule": "last-business", "from": "1405-07-01", "count": 4},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/tenantsساختن حساب و نخستین کلید API (ویژهی اپراتور)نیازمند توکن اپراتور| نام | نوع | الزام | توضیح |
|---|---|---|---|
name | string | الزامی | |
billing_email | string | اختیاری | |
environment | Environment | اختیاری | مقدارها: live، test |
TenantCreatedinvalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.unauthorizedبرای این درخواست کلید API معتبر لازم است.forbiddenاین اعتبارنامه اجازهی انجام این کار را ندارد.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.internal_errorخطای پیشبینینشدهای رخ داد.این عملیات ویژهی اپراتور سرویس است و توکن اپراتور لازم دارد.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X POST "https://api.taghvim.dev/v1/tenants" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_OPERATOR_TOKEN" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"name":"Acme Clinic","billing_email":"billing@example.com","environment":"test"}'const res = await fetch("https://api.taghvim.dev/v1/tenants", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_OPERATOR_TOKEN}`,
"Idempotency-Key": crypto.randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "Acme Clinic",
"billing_email": "billing@example.com",
"environment": "test"
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.post(
"https://api.taghvim.dev/v1/tenants",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_OPERATOR_TOKEN']}", "Idempotency-Key": str(uuid.uuid4())},
json={"name": "Acme Clinic", "billing_email": "billing@example.com", "environment": "test"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/meحساب و کلیدی که این درخواست را فرستاده استنیازمند کلید APIMekey_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/me" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/me", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/me",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/keysساختن کلید APIنیازمند کلید API| نام | نوع | الزام | توضیح |
|---|---|---|---|
name | string | اختیاری | |
environment | Environment | اختیاری | مقدارها: live، test |
ApiKeyWithSecretinvalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X POST "https://api.taghvim.dev/v1/keys" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"name":"server","environment":"live"}'const res = await fetch("https://api.taghvim.dev/v1/keys", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "server",
"environment": "live"
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.post(
"https://api.taghvim.dev/v1/keys",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={"name": "server", "environment": "live"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/keysفهرست کلیدهای APIنیازمند کلید APIApiKeyListkey_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/keys" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/keys", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/keys",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/keys/{id}باطل کردن کلید APIنیازمند کلید API| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
id | مسیر | string | الزامی |
ApiKeyvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.not_foundمنبع خواستهشده پیدا نشد.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X DELETE "https://api.taghvim.dev/v1/keys/{id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const res = await fetch("https://api.taghvim.dev/v1/keys/{id}", {
method: "DELETE",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.delete(
"https://api.taghvim.dev/v1/keys/{id}",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/usageمصرف در یک دورهنیازمند کلید API| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
period | پرسوجو | string | اختیاری |
Usagevalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.out_of_rangeمقدار واردشده بیرون از بازهی پشتیبانیشده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/usage?period=1405-07" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/usage?period=1405-07", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/usage",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
params={"period": "1405-07"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/usage/exportخروجی صورتحساب یک دورهنیازمند کلید API| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
period | پرسوجو | string | اختیاری | |
format | پرسوجو | object | اختیاری |
UsageExportvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.out_of_rangeمقدار واردشده بیرون از بازهی پشتیبانیشده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/usage/export?period=1405-07&format=json" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/usage/export?period=1405-07&format=json", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/usage/export",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
params={"period": "1405-07", "format": "json"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/plansپلنها و قیمتهانیازمند کلید APIPlanListkey_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/plans" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/plans", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/plans",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/subscriptionاشتراک فعلینیازمند کلید APISubscriptionkey_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/subscription" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/subscription", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/subscription",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/admin/billing-exportخروجی صورتحساب همهی حسابها (ویژهی اپراتور)نیازمند توکن اپراتور| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
period | پرسوجو | string | اختیاری |
BillingExportvalidation_failedدرخواست با قرارداد API همخوان نیست.unauthorizedبرای این درخواست کلید API معتبر لازم است.forbiddenاین اعتبارنامه اجازهی انجام این کار را ندارد.out_of_rangeمقدار واردشده بیرون از بازهی پشتیبانیشده است.internal_errorخطای پیشبینینشدهای رخ داد.این عملیات ویژهی اپراتور سرویس است و توکن اپراتور لازم دارد.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/admin/billing-export?period=1405-07" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_OPERATOR_TOKEN"const res = await fetch("https://api.taghvim.dev/v1/admin/billing-export?period=1405-07", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_OPERATOR_TOKEN}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/admin/billing-export",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_OPERATOR_TOKEN']}"},
params={"period": "1405-07"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/payment-intentsساختن درخواست پرداخت برای خرید پلننیازمند کلید APIبرای پلن انتخابشده درخواست پرداخت میسازد و نشانی صفحهی پرداخت را برمیگرداند. تا پیش از راهاندازی پرداخت آنلاین، پاسخ خطای payments_not_configured است.
| نام | نوع | الزام | توضیح |
|---|---|---|---|
plan_id | string | الزامی | |
mobile_number | string | اختیاری |
PaymentIntentidempotency_key_requiredاین عملیات به سرآیند Idempotency-Key نیاز دارد.invalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.not_foundمنبع خواستهشده پیدا نشد.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.plan_unchangedحساب شما هماکنون روی همین پلن یا پلن بالاتری است.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.plan_not_purchasableاین پلن را نمیتوان بهصورت آنلاین خرید.internal_errorخطای پیشبینینشدهای رخ داد.payment_provider_errorدرگاه پرداخت خطا برگرداند.payments_not_configuredپرداخت آنلاین هنوز راهاندازی نشده است.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X POST "https://api.taghvim.dev/v1/payment-intents" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"plan_id":"plan_builder"}'const res = await fetch("https://api.taghvim.dev/v1/payment-intents", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
"plan_id": "plan_builder"
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.post(
"https://api.taghvim.dev/v1/payment-intents",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={"plan_id": "plan_builder"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/payment-intents/{id}وضعیت درخواست پرداختنیازمند کلید API| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
id | مسیر | string | الزامی |
PaymentIntentvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.not_foundمنبع خواستهشده پیدا نشد.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/payment-intents/{id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/payment-intents/{id}", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/payment-intents/{id}",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/payment-intents/{id}/verifyتأیید پرداخت از درگاهنیازمند کلید APIاگر بازگشت از درگاه گم شده باشد، این عملیات وضعیت پرداخت را از درگاه میپرسد و در صورت تأیید، پلن را ارتقا میدهد.
| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
id | مسیر | string | الزامی |
PaymentIntentvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.not_foundمنبع خواستهشده پیدا نشد.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.payment_amount_mismatchمبلغ تأییدشده با مبلغ درخواست پرداخت یکسان نیست.payment_intent_stateوضعیت درخواست پرداخت اجازهی این کار را نمیدهد.internal_errorخطای پیشبینینشدهای رخ داد.payment_provider_errorدرگاه پرداخت خطا برگرداند.payments_not_configuredپرداخت آنلاین هنوز راهاندازی نشده است.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X POST "https://api.taghvim.dev/v1/payment-intents/{id}/verify" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const res = await fetch("https://api.taghvim.dev/v1/payment-intents/{id}/verify", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.post(
"https://api.taghvim.dev/v1/payment-intents/{id}/verify",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/payment-intents/{id}/cancelلغو درخواست پرداختنیازمند کلید API| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
id | مسیر | string | الزامی |
PaymentIntentvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.not_foundمنبع خواستهشده پیدا نشد.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.payment_intent_stateوضعیت درخواست پرداخت اجازهی این کار را نمیدهد.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X POST "https://api.taghvim.dev/v1/payment-intents/{id}/cancel" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const res = await fetch("https://api.taghvim.dev/v1/payment-intents/{id}/cancel", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.post(
"https://api.taghvim.dev/v1/payment-intents/{id}/cancel",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/billing/callback/vandarبازگشت پرداختکننده از درگاهبدون کلیدپرداختکننده پس از پرداخت به این نشانی برمیگردد. این بازگشت فقط یک نشانه است: پرداخت تنها پس از تأیید مستقیم از درگاه و برابری مبلغ، موفق ثبت میشود.
| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
token | پرسوجو | string | الزامی | |
payment_status | پرسوجو | string | اختیاری |
validation_failedدرخواست با قرارداد API همخوان نیست.internal_errorخطای پیشبینینشدهای رخ داد.وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/billing/callback/vandar" \
-H "Accept: text/html"const res = await fetch("https://api.taghvim.dev/v1/billing/callback/vandar", {
method: "GET",
headers: {
Accept: "text/html",
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/billing/callback/vandar",
headers={"Accept": "text/html"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/receipts/{id}دریافت رسیدنیازمند کلید API| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
id | مسیر | string | الزامی |
Receiptvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.not_foundمنبع خواستهشده پیدا نشد.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/receipts/{id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/receipts/{id}", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/receipts/{id}",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/receipts/{id}/deliveriesوضعیت ارسال رسیدنیازمند کلید API| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
id | مسیر | string | الزامی |
ReceiptDeliveryListvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.not_foundمنبع خواستهشده پیدا نشد.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/receipts/{id}/deliveries" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/receipts/{id}/deliveries", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/receipts/{id}/deliveries",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/event-logگزارش رویدادهای حسابنیازمند کلید APIرویدادهای ثبتشدهی حساب، تازهترین در ابتدا. شناسهی هر رویداد با evtlog_ آغاز میشود؛ evt_ برای رویدادهای تقویم کنار گذاشته شده است.
| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
type | پرسوجو | EventType | اختیاری | |
limit | پرسوجو | integer | اختیاری |
EventListvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/event-log" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/event-log", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/event-log",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/event-log/{id}یک رویداد از گزارش رویدادهانیازمند کلید API| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
id | مسیر | string | الزامی |
Eventvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.not_foundمنبع خواستهشده پیدا نشد.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/event-log/{id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/event-log/{id}", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/event-log/{id}",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/event-typesانواع رویدادبدون کلیدEventTypeListinternal_errorخطای پیشبینینشدهای رخ داد.وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/event-types" \
-H "Accept: application/json"const res = await fetch("https://api.taghvim.dev/v1/event-types", {
method: "GET",
headers: {
Accept: "application/json",
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/event-types",
headers={"Accept": "application/json"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/webhooksساختن نشانی وبهوکنیازمند کلید API| نام | نوع | الزام | توضیح |
|---|---|---|---|
url | string | الزامی | |
event_types | EventType[] | الزامی | |
description | string | اختیاری |
WebhookWithSecretinvalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.webhook_limit_reachedبه سقف تعداد نشانیهای وبهوک رسیدهاید.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.webhook_url_rejectedنشانی وبهوک باید یک نشانی عمومی HTTPS باشد.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X POST "https://api.taghvim.dev/v1/webhooks" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"url":"https://example.com/webhooks/taghvim","event_types":["taghvim.event.payment.intent.verified.v1"]}'const res = await fetch("https://api.taghvim.dev/v1/webhooks", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
"url": "https://example.com/webhooks/taghvim",
"event_types": [
"taghvim.event.payment.intent.verified.v1"
]
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.post(
"https://api.taghvim.dev/v1/webhooks",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={"url": "https://example.com/webhooks/taghvim", "event_types": ["taghvim.event.payment.intent.verified.v1"]},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/webhooksفهرست نشانیهای وبهوکنیازمند کلید APIWebhookListkey_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/webhooks" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/webhooks", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/webhooks",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/webhooks/{id}دریافت نشانی وبهوکنیازمند کلید API| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
id | مسیر | string | الزامی |
Webhookvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.not_foundمنبع خواستهشده پیدا نشد.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/webhooks/{id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/webhooks/{id}", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/webhooks/{id}",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/webhooks/{id}غیرفعال کردن نشانی وبهوکنیازمند کلید API| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
id | مسیر | string | الزامی |
Webhookvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.not_foundمنبع خواستهشده پیدا نشد.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X DELETE "https://api.taghvim.dev/v1/webhooks/{id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const res = await fetch("https://api.taghvim.dev/v1/webhooks/{id}", {
method: "DELETE",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.delete(
"https://api.taghvim.dev/v1/webhooks/{id}",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/webhooks/{id}/rotate-secretتعویض کلید امضانیازمند کلید APIکلید تازه میسازد؛ کلید قبلی تا پایان دورهی همپوشانی هم امضا میکند.
| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
id | مسیر | string | الزامی |
WebhookWithSecretvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.not_foundمنبع خواستهشده پیدا نشد.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X POST "https://api.taghvim.dev/v1/webhooks/{id}/rotate-secret" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const res = await fetch("https://api.taghvim.dev/v1/webhooks/{id}/rotate-secret", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.post(
"https://api.taghvim.dev/v1/webhooks/{id}/rotate-secret",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/webhooks/{id}/deliveriesگزارش تحویلهای یک وبهوکنیازمند کلید API| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
id | مسیر | string | الزامی |
DeliveryListvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.not_foundمنبع خواستهشده پیدا نشد.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/webhooks/{id}/deliveries" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/webhooks/{id}/deliveries", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/webhooks/{id}/deliveries",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/webhooks/{id}/testارسال تحویل آزمایشینیازمند کلید API| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
id | مسیر | string | الزامی |
Eventvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.not_foundمنبع خواستهشده پیدا نشد.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X POST "https://api.taghvim.dev/v1/webhooks/{id}/test" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const res = await fetch("https://api.taghvim.dev/v1/webhooks/{id}/test", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.post(
"https://api.taghvim.dev/v1/webhooks/{id}/test",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/connectors/payment/standardاستاندارد اتصال پرداختبدون کلیدPaymentConnectorStandardinternal_errorخطای پیشبینینشدهای رخ داد.وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/connectors/payment/standard" \
-H "Accept: application/json"const res = await fetch("https://api.taghvim.dev/v1/connectors/payment/standard", {
method: "GET",
headers: {
Accept: "application/json",
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/connectors/payment/standard",
headers={"Accept": "application/json"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/connectors/payment/manifests/validateبررسی مانیفست آداپتوربدون کلیدManifestValidationinvalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.internal_errorخطای پیشبینینشدهای رخ داد.وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X POST "https://api.taghvim.dev/v1/connectors/payment/manifests/validate" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{}'const res = await fetch("https://api.taghvim.dev/v1/connectors/payment/manifests/validate", {
method: "POST",
headers: {
Accept: "application/json",
"Content-Type": "application/json",
},
body: JSON.stringify({}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.post(
"https://api.taghvim.dev/v1/connectors/payment/manifests/validate",
headers={"Accept": "application/json"},
json={},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/workspaces/currentدریافت فضای کاری و اختیار انتشارنیازمند کلید APIPublicationWorkspacekey_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.not_foundمنبع خواستهشده پیدا نشد.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/workspaces/current" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/workspaces/current", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/workspaces/current",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/calendarsایجاد پیشنویس تقویم سازمانینیازمند کلید API| نام | نوع | الزام | توضیح |
|---|---|---|---|
version | integer | الزامی | بازه: ۱…… |
tenant_id | string | الزامی | |
workspace_id | string | الزامی | |
namespace | string | الزامی | |
calendar_id | string | الزامی | |
status | object | الزامی | مقدارها: draft، published، unpublished، archived |
visibility | object | الزامی | مقدارها: private، unlisted، public |
sector_pack | PublicationSectorPack | الزامی | |
sector_pack.id | string | الزامی | |
sector_pack.version | string | الزامی | |
sector_pack.schema_refs | string[] | الزامی | |
sector_pack.policy_refs | string[] | الزامی | |
sector_pack.label_namespace | string | اختیاری | |
entities | PublicationEntity[] | الزامی | |
entities[].id | PublicationEntityId | الزامی | |
entities[].kind | string | الزامی | |
entities[].namespace | string | الزامی | |
entities[].status | object | الزامی | مقدارها: draft، active، cancelled، archived |
entities[].visibility | object | الزامی | مقدارها: private، unlisted، public |
entities[].labels | object | الزامی | |
entities[].tags | string[] | اختیاری | |
entities[].attributes | object | اختیاری | |
entities[].evidence_refs | string[] | اختیاری | |
entities[].version | integer | اختیاری | بازه: ۱…… |
relationships | PublicationRelationship[] | الزامی | |
relationships[].id | string | الزامی | |
relationships[].source_id | string | الزامی | |
relationships[].target_id | string | الزامی | |
relationships[].kind | string | الزامی | |
relationships[].role | string | اختیاری | |
relationships[].policy_ref | string | الزامی | |
relationships[].valid_from | string | اختیاری | |
relationships[].valid_to | string | اختیاری | |
relationships[].federation_authority_ref | string | اختیاری | |
relationships[].evidence_refs | string[] | اختیاری | |
occurrences | PublicationOccurrence[] | الزامی | |
occurrences[].id | string | الزامی | |
occurrences[].event_id | string | الزامی | |
occurrences[].starts_at | string | الزامی | |
occurrences[].ends_at | string | الزامی | |
occurrences[].timezone | string | الزامی | |
occurrences[].calendar_system | object | الزامی | مقدارها: gregorian، jalali، hijri، mixed |
occurrences[].temporal_policy_ref | string | الزامی | |
occurrences[].ambiguity | object | اختیاری | مقدارها: none، predicted، ambiguous، unresolved |
occurrences[].evidence_refs | string[] | اختیاری | |
labels | object | اختیاری | |
policy_refs | string[] | اختیاری | |
evidence_refs | string[] | اختیاری |
CalendarPublicationidempotency_key_requiredاین عملیات به سرآیند Idempotency-Key نیاز دارد.invalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.forbiddenاین اعتبارنامه اجازهی انجام این کار را ندارد.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.publication_conflictتقویم تکراری است، نسخهٔ آن تغییر کرده یا این انتقال وضعیت مجاز نیست.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X POST "https://api.taghvim.dev/v1/calendars" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"version":1,"tenant_id":"tenant_example","workspace_id":"workspace_example","namespace":"taghvim://example/calendar","calendar_id":"calendar_example_0001","status":"draft","visibility":"private","sector_pack":{"id":"example_0001","version":"1.0.0","schema_refs":[],"policy_refs":[]},"entities":[{"id":"calendar_example_0001","kind":"calendar","namespace":"taghvim://example/calendar","status":"active","visibility":"private","labels":{"fa":"تقویم نمونه"}}],"relationships":[],"occurrences":[]}'const res = await fetch("https://api.taghvim.dev/v1/calendars", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
"version": 1,
"tenant_id": "tenant_example",
"workspace_id": "workspace_example",
"namespace": "taghvim://example/calendar",
"calendar_id": "calendar_example_0001",
"status": "draft",
"visibility": "private",
"sector_pack": {
"id": "example_0001",
"version": "1.0.0",
"schema_refs": [],
"policy_refs": []
},
"entities": [
{
"id": "calendar_example_0001",
"kind": "calendar",
"namespace": "taghvim://example/calendar",
"status": "active",
"visibility": "private",
"labels": {
"fa": "تقویم نمونه"
}
}
],
"relationships": [],
"occurrences": []
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.post(
"https://api.taghvim.dev/v1/calendars",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={"version": 1, "tenant_id": "tenant_example", "workspace_id": "workspace_example", "namespace": "taghvim://example/calendar", "calendar_id": "calendar_example_0001", "status": "draft", "visibility": "private", "sector_pack": {"id": "example_0001", "version": "1.0.0", "schema_refs": [], "policy_refs": []}, "entities": [{"id": "calendar_example_0001", "kind": "calendar", "namespace": "taghvim://example/calendar", "status": "active", "visibility": "private", "labels": {"fa": "تقویم نمونه"}}], "relationships": [], "occurrences": []},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/calendars/{calendar_id}دریافت تقویم فضای کاری مجازنیازمند کلید API| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
calendar_id | مسیر | string | الزامی |
CalendarPublicationvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.not_foundمنبع خواستهشده پیدا نشد.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/calendars/{calendar_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/calendars/{calendar_id}", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/calendars/{calendar_id}",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/calendars/{calendar_id}ویرایش نسخهدار تقویم خصوصینیازمند کلید API| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
calendar_id | مسیر | string | الزامی |
| نام | نوع | الزام | توضیح |
|---|---|---|---|
version | integer | الزامی | بازه: ۱…… |
tenant_id | string | الزامی | |
workspace_id | string | الزامی | |
namespace | string | الزامی | |
calendar_id | string | الزامی | |
status | object | الزامی | مقدارها: draft، published، unpublished، archived |
visibility | object | الزامی | مقدارها: private، unlisted، public |
sector_pack | PublicationSectorPack | الزامی | |
sector_pack.id | string | الزامی | |
sector_pack.version | string | الزامی | |
sector_pack.schema_refs | string[] | الزامی | |
sector_pack.policy_refs | string[] | الزامی | |
sector_pack.label_namespace | string | اختیاری | |
entities | PublicationEntity[] | الزامی | |
entities[].id | PublicationEntityId | الزامی | |
entities[].kind | string | الزامی | |
entities[].namespace | string | الزامی | |
entities[].status | object | الزامی | مقدارها: draft، active، cancelled، archived |
entities[].visibility | object | الزامی | مقدارها: private، unlisted، public |
entities[].labels | object | الزامی | |
entities[].tags | string[] | اختیاری | |
entities[].attributes | object | اختیاری | |
entities[].evidence_refs | string[] | اختیاری | |
entities[].version | integer | اختیاری | بازه: ۱…… |
relationships | PublicationRelationship[] | الزامی | |
relationships[].id | string | الزامی | |
relationships[].source_id | string | الزامی | |
relationships[].target_id | string | الزامی | |
relationships[].kind | string | الزامی | |
relationships[].role | string | اختیاری | |
relationships[].policy_ref | string | الزامی | |
relationships[].valid_from | string | اختیاری | |
relationships[].valid_to | string | اختیاری | |
relationships[].federation_authority_ref | string | اختیاری | |
relationships[].evidence_refs | string[] | اختیاری | |
occurrences | PublicationOccurrence[] | الزامی | |
occurrences[].id | string | الزامی | |
occurrences[].event_id | string | الزامی | |
occurrences[].starts_at | string | الزامی | |
occurrences[].ends_at | string | الزامی | |
occurrences[].timezone | string | الزامی | |
occurrences[].calendar_system | object | الزامی | مقدارها: gregorian، jalali، hijri، mixed |
occurrences[].temporal_policy_ref | string | الزامی | |
occurrences[].ambiguity | object | اختیاری | مقدارها: none، predicted، ambiguous، unresolved |
occurrences[].evidence_refs | string[] | اختیاری | |
labels | object | اختیاری | |
policy_refs | string[] | اختیاری | |
evidence_refs | string[] | اختیاری |
CalendarPublicationidempotency_key_requiredاین عملیات به سرآیند Idempotency-Key نیاز دارد.invalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.forbiddenاین اعتبارنامه اجازهی انجام این کار را ندارد.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.publication_conflictتقویم تکراری است، نسخهٔ آن تغییر کرده یا این انتقال وضعیت مجاز نیست.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X PATCH "https://api.taghvim.dev/v1/calendars/{calendar_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"version":1,"tenant_id":"tenant_example","workspace_id":"workspace_example","namespace":"taghvim://example/calendar","calendar_id":"calendar_example_0001","status":"draft","visibility":"private","sector_pack":{"id":"example_0001","version":"1.0.0","schema_refs":[],"policy_refs":[]},"entities":[{"id":"calendar_example_0001","kind":"calendar","namespace":"taghvim://example/calendar","status":"active","visibility":"private","labels":{"fa":"تقویم نمونه"}}],"relationships":[],"occurrences":[]}'const res = await fetch("https://api.taghvim.dev/v1/calendars/{calendar_id}", {
method: "PATCH",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
"version": 1,
"tenant_id": "tenant_example",
"workspace_id": "workspace_example",
"namespace": "taghvim://example/calendar",
"calendar_id": "calendar_example_0001",
"status": "draft",
"visibility": "private",
"sector_pack": {
"id": "example_0001",
"version": "1.0.0",
"schema_refs": [],
"policy_refs": []
},
"entities": [
{
"id": "calendar_example_0001",
"kind": "calendar",
"namespace": "taghvim://example/calendar",
"status": "active",
"visibility": "private",
"labels": {
"fa": "تقویم نمونه"
}
}
],
"relationships": [],
"occurrences": []
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.patch(
"https://api.taghvim.dev/v1/calendars/{calendar_id}",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={"version": 1, "tenant_id": "tenant_example", "workspace_id": "workspace_example", "namespace": "taghvim://example/calendar", "calendar_id": "calendar_example_0001", "status": "draft", "visibility": "private", "sector_pack": {"id": "example_0001", "version": "1.0.0", "schema_refs": [], "policy_refs": []}, "entities": [{"id": "calendar_example_0001", "kind": "calendar", "namespace": "taghvim://example/calendar", "status": "active", "visibility": "private", "labels": {"fa": "تقویم نمونه"}}], "relationships": [], "occurrences": []},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/calendars/{calendar_id}/publishانتشار اتمیک نمای عمومی تقویمنیازمند کلید API| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
calendar_id | مسیر | string | الزامی |
| نام | نوع | الزام | توضیح |
|---|---|---|---|
expected_version | integer | الزامی | بازه: ۱…… |
CalendarPublicationidempotency_key_requiredاین عملیات به سرآیند Idempotency-Key نیاز دارد.invalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.forbiddenاین اعتبارنامه اجازهی انجام این کار را ندارد.not_foundمنبع خواستهشده پیدا نشد.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.publication_conflictتقویم تکراری است، نسخهٔ آن تغییر کرده یا این انتقال وضعیت مجاز نیست.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X POST "https://api.taghvim.dev/v1/calendars/{calendar_id}/publish" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"expected_version":1}'const res = await fetch("https://api.taghvim.dev/v1/calendars/{calendar_id}/publish", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
"expected_version": 1
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.post(
"https://api.taghvim.dev/v1/calendars/{calendar_id}/publish",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={"expected_version": 1},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/calendars/{calendar_id}/unpublishلغو انتشار عمومی تقویمنیازمند کلید API| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
calendar_id | مسیر | string | الزامی |
| نام | نوع | الزام | توضیح |
|---|---|---|---|
expected_version | integer | الزامی | بازه: ۱…… |
CalendarPublicationidempotency_key_requiredاین عملیات به سرآیند Idempotency-Key نیاز دارد.invalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.forbiddenاین اعتبارنامه اجازهی انجام این کار را ندارد.not_foundمنبع خواستهشده پیدا نشد.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.publication_conflictتقویم تکراری است، نسخهٔ آن تغییر کرده یا این انتقال وضعیت مجاز نیست.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X POST "https://api.taghvim.dev/v1/calendars/{calendar_id}/unpublish" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"expected_version":1}'const res = await fetch("https://api.taghvim.dev/v1/calendars/{calendar_id}/unpublish", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
"expected_version": 1
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.post(
"https://api.taghvim.dev/v1/calendars/{calendar_id}/unpublish",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={"expected_version": 1},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/public/calendars/{calendar_id}نمای عمومی مجاز تقویمبدون کلید| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
calendar_id | مسیر | string | الزامی |
PublicCalendarViewvalidation_failedدرخواست با قرارداد API همخوان نیست.not_foundمنبع خواستهشده پیدا نشد.internal_errorخطای پیشبینینشدهای رخ داد.وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/public/calendars/{calendar_id}" \
-H "Accept: application/json"const res = await fetch("https://api.taghvim.dev/v1/public/calendars/{calendar_id}", {
method: "GET",
headers: {
Accept: "application/json",
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/public/calendars/{calendar_id}",
headers={"Accept": "application/json"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/public/calendars/{calendar_id}/icsدریافت اشتراک استاندارد ICS تقویم عمومیبدون کلید| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
calendar_id | مسیر | string | الزامی |
validation_failedدرخواست با قرارداد API همخوان نیست.not_foundمنبع خواستهشده پیدا نشد.internal_errorخطای پیشبینینشدهای رخ داد.وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/public/calendars/{calendar_id}/ics" \
-H "Accept: text/calendar"const res = await fetch("https://api.taghvim.dev/v1/public/calendars/{calendar_id}/ics", {
method: "GET",
headers: {
Accept: "text/calendar",
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/public/calendars/{calendar_id}/ics",
headers={"Accept": "text/calendar"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/public/calendar-searchجستوجوی تقویمهای منتشرشدهبدون کلید| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
q | پرسوجو | string | اختیاری | |
limit | پرسوجو | integer | اختیاری |
PublicCalendarSearchResultvalidation_failedدرخواست با قرارداد API همخوان نیست.internal_errorخطای پیشبینینشدهای رخ داد.وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/public/calendar-search" \
-H "Accept: application/json"const res = await fetch("https://api.taghvim.dev/v1/public/calendar-search", {
method: "GET",
headers: {
Accept: "application/json",
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/public/calendar-search",
headers={"Accept": "application/json"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/workspacesایجاد فضای کاری فرزند با مجوز مالکنیازمند کلید APIایجاد فضای کاری فرزند با مجوز مالک
| نام | نوع | الزام | توضیح |
|---|---|---|---|
kind | object | الزامی | مقدارها: organisation، partner، reseller، distributor، department، team، customer، agent |
PublicationWorkspaceidempotency_key_requiredاین عملیات به سرآیند Idempotency-Key نیاز دارد.invalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.forbiddenاین اعتبارنامه اجازهی انجام این کار را ندارد.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.publication_conflictتقویم تکراری است، نسخهٔ آن تغییر کرده یا این انتقال وضعیت مجاز نیست.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X POST "https://api.taghvim.dev/v1/workspaces" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"kind":"partner"}'const res = await fetch("https://api.taghvim.dev/v1/workspaces", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
"kind": "partner"
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.post(
"https://api.taghvim.dev/v1/workspaces",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={"kind": "partner"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/workspaces/{workspace_id}خواندن فضای کاری دارای مجوزنیازمند کلید APIخواندن فضای کاری دارای مجوز
| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
workspace_id | مسیر | string | الزامی |
PublicationWorkspacevalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.forbiddenاین اعتبارنامه اجازهی انجام این کار را ندارد.not_foundمنبع خواستهشده پیدا نشد.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/workspaces/{workspace_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/workspaces/{workspace_id}", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/workspaces/{workspace_id}",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/calendars/{calendar_id}/eventsایجاد رویداد نسخهدار در گراف تقویم خصوصینیازمند کلید APIایجاد رویداد نسخهدار در گراف تقویم خصوصی
| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
calendar_id | مسیر | string | الزامی |
| نام | نوع | الزام | توضیح |
|---|---|---|---|
expected_version | integer | الزامی | بازه: ۱…… |
entity | PublicationEntity | الزامی | |
entity.id | PublicationEntityId | الزامی | |
entity.kind | string | الزامی | |
entity.namespace | string | الزامی | |
entity.status | object | الزامی | مقدارها: draft، active، cancelled، archived |
entity.visibility | object | الزامی | مقدارها: private، unlisted، public |
entity.labels | object | الزامی | |
entity.tags | string[] | اختیاری | |
entity.attributes | object | اختیاری | |
entity.evidence_refs | string[] | اختیاری | |
entity.version | integer | اختیاری | بازه: ۱…… |
occurrences | PublicationOccurrence[] | الزامی | |
occurrences[].id | string | الزامی | |
occurrences[].event_id | string | الزامی | |
occurrences[].starts_at | string | الزامی | |
occurrences[].ends_at | string | الزامی | |
occurrences[].timezone | string | الزامی | |
occurrences[].calendar_system | object | الزامی | مقدارها: gregorian، jalali، hijri، mixed |
occurrences[].temporal_policy_ref | string | الزامی | |
occurrences[].ambiguity | object | اختیاری | مقدارها: none، predicted، ambiguous، unresolved |
occurrences[].evidence_refs | string[] | اختیاری |
CalendarEventMutationResultidempotency_key_requiredاین عملیات به سرآیند Idempotency-Key نیاز دارد.invalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.forbiddenاین اعتبارنامه اجازهی انجام این کار را ندارد.not_foundمنبع خواستهشده پیدا نشد.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.publication_conflictتقویم تکراری است، نسخهٔ آن تغییر کرده یا این انتقال وضعیت مجاز نیست.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X POST "https://api.taghvim.dev/v1/calendars/{calendar_id}/events" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"expected_version":1,"entity":{"id":"example_0001","kind":"rel_example_00000001","namespace":"taghvim://example/calendar","status":"draft","visibility":"private","labels":{"example":"taghvim://example/calendar"}},"occurrences":[{"id":"occ_example_00000001","event_id":"taghvim://example/calendar","starts_at":"2026-11-19T09:00:00Z","ends_at":"2026-11-19T10:00:00Z","timezone":"Asia/Tehran","calendar_system":"gregorian","temporal_policy_ref":"policy_example"}]}'const res = await fetch("https://api.taghvim.dev/v1/calendars/{calendar_id}/events", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
"expected_version": 1,
"entity": {
"id": "example_0001",
"kind": "rel_example_00000001",
"namespace": "taghvim://example/calendar",
"status": "draft",
"visibility": "private",
"labels": {
"example": "taghvim://example/calendar"
}
},
"occurrences": [
{
"id": "occ_example_00000001",
"event_id": "taghvim://example/calendar",
"starts_at": "2026-11-19T09:00:00Z",
"ends_at": "2026-11-19T10:00:00Z",
"timezone": "Asia/Tehran",
"calendar_system": "gregorian",
"temporal_policy_ref": "policy_example"
}
]
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.post(
"https://api.taghvim.dev/v1/calendars/{calendar_id}/events",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={"expected_version": 1, "entity": {"id": "example_0001", "kind": "rel_example_00000001", "namespace": "taghvim://example/calendar", "status": "draft", "visibility": "private", "labels": {"example": "taghvim://example/calendar"}}, "occurrences": [{"id": "occ_example_00000001", "event_id": "taghvim://example/calendar", "starts_at": "2026-11-19T09:00:00Z", "ends_at": "2026-11-19T10:00:00Z", "timezone": "Asia/Tehran", "calendar_system": "gregorian", "temporal_policy_ref": "policy_example"}]},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/calendars/{calendar_id}/eventsفهرست رویدادهای خصوصی در فضای کاری مجازنیازمند کلید APIفهرست رویدادهای خصوصی در فضای کاری مجاز
| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
calendar_id | مسیر | string | الزامی |
CalendarEventListvalidation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.forbiddenاین اعتبارنامه اجازهی انجام این کار را ندارد.not_foundمنبع خواستهشده پیدا نشد.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/calendars/{calendar_id}/events" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY"const res = await fetch("https://api.taghvim.dev/v1/calendars/{calendar_id}/events", {
method: "GET",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/calendars/{calendar_id}/events",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/calendars/{calendar_id}/events/{event_id}ویرایش رویداد با مقایسهٔ اتمیک نسخهنیازمند کلید APIویرایش رویداد با مقایسهٔ اتمیک نسخه
| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
calendar_id | مسیر | string | الزامی | |
event_id | مسیر | PublicationEntityId | الزامی |
| نام | نوع | الزام | توضیح |
|---|---|---|---|
expected_version | integer | الزامی | بازه: ۱…… |
entity | PublicationEntity | الزامی | |
entity.id | PublicationEntityId | الزامی | |
entity.kind | string | الزامی | |
entity.namespace | string | الزامی | |
entity.status | object | الزامی | مقدارها: draft، active، cancelled، archived |
entity.visibility | object | الزامی | مقدارها: private، unlisted، public |
entity.labels | object | الزامی | |
entity.tags | string[] | اختیاری | |
entity.attributes | object | اختیاری | |
entity.evidence_refs | string[] | اختیاری | |
entity.version | integer | اختیاری | بازه: ۱…… |
occurrences | PublicationOccurrence[] | الزامی | |
occurrences[].id | string | الزامی | |
occurrences[].event_id | string | الزامی | |
occurrences[].starts_at | string | الزامی | |
occurrences[].ends_at | string | الزامی | |
occurrences[].timezone | string | الزامی | |
occurrences[].calendar_system | object | الزامی | مقدارها: gregorian، jalali، hijri، mixed |
occurrences[].temporal_policy_ref | string | الزامی | |
occurrences[].ambiguity | object | اختیاری | مقدارها: none، predicted، ambiguous، unresolved |
occurrences[].evidence_refs | string[] | اختیاری |
CalendarEventMutationResultidempotency_key_requiredاین عملیات به سرآیند Idempotency-Key نیاز دارد.invalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.forbiddenاین اعتبارنامه اجازهی انجام این کار را ندارد.not_foundمنبع خواستهشده پیدا نشد.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.publication_conflictتقویم تکراری است، نسخهٔ آن تغییر کرده یا این انتقال وضعیت مجاز نیست.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X PATCH "https://api.taghvim.dev/v1/calendars/{calendar_id}/events/{event_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"expected_version":1,"entity":{"id":"example_0001","kind":"rel_example_00000001","namespace":"taghvim://example/calendar","status":"draft","visibility":"private","labels":{"example":"taghvim://example/calendar"}},"occurrences":[{"id":"occ_example_00000001","event_id":"taghvim://example/calendar","starts_at":"2026-11-19T09:00:00Z","ends_at":"2026-11-19T10:00:00Z","timezone":"Asia/Tehran","calendar_system":"gregorian","temporal_policy_ref":"policy_example"}]}'const res = await fetch("https://api.taghvim.dev/v1/calendars/{calendar_id}/events/{event_id}", {
method: "PATCH",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
"expected_version": 1,
"entity": {
"id": "example_0001",
"kind": "rel_example_00000001",
"namespace": "taghvim://example/calendar",
"status": "draft",
"visibility": "private",
"labels": {
"example": "taghvim://example/calendar"
}
},
"occurrences": [
{
"id": "occ_example_00000001",
"event_id": "taghvim://example/calendar",
"starts_at": "2026-11-19T09:00:00Z",
"ends_at": "2026-11-19T10:00:00Z",
"timezone": "Asia/Tehran",
"calendar_system": "gregorian",
"temporal_policy_ref": "policy_example"
}
]
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.patch(
"https://api.taghvim.dev/v1/calendars/{calendar_id}/events/{event_id}",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={"expected_version": 1, "entity": {"id": "example_0001", "kind": "rel_example_00000001", "namespace": "taghvim://example/calendar", "status": "draft", "visibility": "private", "labels": {"example": "taghvim://example/calendar"}}, "occurrences": [{"id": "occ_example_00000001", "event_id": "taghvim://example/calendar", "starts_at": "2026-11-19T09:00:00Z", "ends_at": "2026-11-19T10:00:00Z", "timezone": "Asia/Tehran", "calendar_system": "gregorian", "temporal_policy_ref": "policy_example"}]},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/public/calendars/{calendar_id}/eventsفهرست فقط رویدادهای صریحاً منتشرشدهبدون کلیدفهرست فقط رویدادهای صریحاً منتشرشده
| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
calendar_id | مسیر | string | الزامی |
PublicCalendarEventsResultvalidation_failedدرخواست با قرارداد API همخوان نیست.not_foundمنبع خواستهشده پیدا نشد.internal_errorخطای پیشبینینشدهای رخ داد.وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl "https://api.taghvim.dev/v1/public/calendars/{calendar_id}/events" \
-H "Accept: application/json"const res = await fetch("https://api.taghvim.dev/v1/public/calendars/{calendar_id}/events", {
method: "GET",
headers: {
Accept: "application/json",
},
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, requests
res = requests.get(
"https://api.taghvim.dev/v1/public/calendars/{calendar_id}/events",
headers={"Accept": "application/json"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/public/calendars/{calendar_id}/subscriptionsاشتراک ثبتشدهٔ خوراک ICS فقط برای تقویم عمومینیازمند کلید APIاشتراک ثبتشدهٔ خوراک ICS فقط برای تقویم عمومی
| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
calendar_id | مسیر | string | الزامی |
| نام | نوع | الزام | توضیح |
|---|---|---|---|
channel | object | الزامی |
FeedSubscriptionidempotency_key_requiredاین عملیات به سرآیند Idempotency-Key نیاز دارد.invalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.forbiddenاین اعتبارنامه اجازهی انجام این کار را ندارد.not_foundمنبع خواستهشده پیدا نشد.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.publication_conflictتقویم تکراری است، نسخهٔ آن تغییر کرده یا این انتقال وضعیت مجاز نیست.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X POST "https://api.taghvim.dev/v1/public/calendars/{calendar_id}/subscriptions" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"channel":"ics"}'const res = await fetch("https://api.taghvim.dev/v1/public/calendars/{calendar_id}/subscriptions", {
method: "POST",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
"channel": "ics"
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.post(
"https://api.taghvim.dev/v1/public/calendars/{calendar_id}/subscriptions",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={"channel": "ics"},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)/v1/calendars/{calendar_id}/notification-preferencesثبت ترجیحات اعلان؛ فعالسازی بدون کانال تحویل معتبر ممنوعنیازمند کلید APIثبت ترجیحات اعلان؛ فعالسازی بدون کانال تحویل معتبر ممنوع
| نام | جایگاه | نوع | الزام | توضیح |
|---|---|---|---|---|
calendar_id | مسیر | string | الزامی |
| نام | نوع | الزام | توضیح |
|---|---|---|---|
enabled | boolean | الزامی | |
channels | object[] | الزامی | |
expected_version | integer | الزامی | بازه: ۰…… |
NotificationPreferencesidempotency_key_requiredاین عملیات به سرآیند Idempotency-Key نیاز دارد.invalid_jsonبدنهی درخواست JSON معتبر نیست.validation_failedدرخواست با قرارداد API همخوان نیست.key_revokedاین کلید API باطل شده است.unauthorizedبرای این درخواست کلید API معتبر لازم است.entitlement_requiredپلن فعلی شما این قابلیت را ندارد.forbiddenاین اعتبارنامه اجازهی انجام این کار را ندارد.not_foundمنبع خواستهشده پیدا نشد.idempotency_conflictاین Idempotency-Key پیشتر با درخواست دیگری به کار رفته است.idempotency_in_progressدرخواستی با همین Idempotency-Key هنوز در حال پردازش است.payload_too_largeحجم بدنهی درخواست بیش از حد مجاز است.unsupported_media_typeبدنهی درخواست را با نوع application/json بفرستید.quota_exceededسهمیهی ماهانهی عملیات پلن شما تمام شده است.internal_errorخطای پیشبینینشدهای رخ داد.فراخوانی واقعی روی حساب شما اجرا میشود و در مصرف شما به حساب میآید.
وضعیت: —
پاسخ پس از ارسال اینجا نمایش داده میشود.curl -X PATCH "https://api.taghvim.dev/v1/calendars/{calendar_id}/notification-preferences" \
-H "Accept: application/json" \
-H "Authorization: Bearer TAGHVIM_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"expected_version":0,"enabled":false,"channels":[]}'const res = await fetch("https://api.taghvim.dev/v1/calendars/{calendar_id}/notification-preferences", {
method: "PATCH",
headers: {
Accept: "application/json",
Authorization: `Bearer ${process.env.TAGHVIM_API_KEY}`,
"Idempotency-Key": crypto.randomUUID(),
"Content-Type": "application/json",
},
body: JSON.stringify({
"expected_version": 0,
"enabled": false,
"channels": []
}),
});
const contentType = (res.headers.get("Content-Type") || "").toLowerCase();
const payload = (res.status === 204 || res.status === 205) ? null :
contentType.includes("json") ? await res.json() :
contentType.startsWith("text/") || contentType.includes("xml") ? await res.text() : await res.arrayBuffer();
console.log(res.status, res.headers.get("Taghvim-Request-Id"), payload);import os, uuid, requests
res = requests.patch(
"https://api.taghvim.dev/v1/calendars/{calendar_id}/notification-preferences",
headers={"Accept": "application/json", "Authorization": f"Bearer {os.environ['TAGHVIM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
json={"expected_version": 0, "enabled": False, "channels": []},
)
content_type = res.headers.get("Content-Type", "").lower()
payload = None if res.status_code in (204, 205) else (res.json() if "json" in content_type else res.text if content_type.startswith("text/") or "xml" in content_type else res.content)
print(res.status_code, res.headers.get("Taghvim-Request-Id"), payload)عملیاتی پیدا نشد.
این صفحه نسخهٔ مشخصی از قرارداد API را نمایش میدهد. نمونههای تقویم در مرورگر اجرا میشوند. پیش از استفادهٔ واقعی، نسخهٔ مستندات باید با API منتشرشده تطبیق داده شود.
محیط تست زمانی
ساعت نمایشی را ثابت نگه دارید یا جلو ببرید و اثر آن را بر سررسیدها و برنامهها ببینید. این شبیهسازی در صفحه، جایگزین محیط آزمایشیِ دارای حساب و کلید API نیست.
فضای کاری نمونه: ۴ یادآور، ۲ برنامه و ۱ سررسید؛ روزهای کاری از موتور تقویم.
آزمودن یک یادآور یکماهه نباید یک ماه طول بکشد.
کاربردها
تقویم، رزرو و گردشکارهای زماندار را به محصولتان اضافه کنید، بیآنکه تیم بکاند زیرسیستم زمان بسازد.
تاریخهای پیش رو، به حساب موتور تقویمموتور تقویم
روز کاری، ساعت قطع، بازههای تسویه، فرایندهای تکرارشونده و سررسیدهای عملیاتی را یکدست و مرجع کنید.
تاریخهای پیش رو، به حساب موتور تقویمموتور تقویم
پزشک، اتاق، تجهیزات و نوبت بیماران را با یک مدل منبع زمانبندی کنید.
تاریخهای پیش رو، به حساب موتور تقویمموتور تقویم
شیفتها، روزهای کاری، مهلت بستن حقوق، بازههای مرخصی و گردشکارهای زماندار.
تاریخهای پیش رو، به حساب موتور تقویمموتور تقویم
سررسیدها را همراه با منشأ، شواهد و سیاست مدیریت کنید.
تاریخهای پیش رو، به حساب موتور تقویمموتور تقویم
ظرفیت زمانی راننده و خودرو، نوبت بارگیری و بازهٔ تحویل.
تاریخهای پیش رو، به حساب موتور تقویمموتور تقویم
برنامهٔ زمانی عاملها، اجرای تکرارشونده، سقف مصرف و رسید اجرا.
تاریخهای پیش رو، به حساب موتور تقویمموتور تقویم
هر نقش، یک نما
یک نقش را انتخاب کنید تا ببینید از کدام رابط استفاده میکند، چه میبیند و چه به دست میآورد.
POST /v1/business-days/addکارشمنطق تاریخ را نمینویسد؛ فراخوانیاش میکند.
عملیاتهای API
از چه چیزهایی استفاده میکند
نتیجهیک فراخوانی، بهجای یک کتابخانهی تاریخ و فایل دستی تعطیلات.
کارشقاعدهها را بیآنکه منتظر انتشار تازه بماند تغییر میدهد.
عملیاتهای API
از چه چیزهایی استفاده میکند
نتیجهقابلیت تازه، بیآنکه منطق زمان از نو نوشته شود.
کارشسررسید، تسویه و بستن دوره را با یک تعریف از روز کاری میبیند.
عملیاتهای API
از چه چیزهایی استفاده میکند
نتیجهعددهایی که میان همهی تیمها یکی است و میشود حسابرسیشان کرد.
کارشحقوق، شیفت و مرخصی را با تعطیلات رسمی هماهنگ میکند.
عملیاتهای API
از چه چیزهایی استفاده میکند
نتیجههیچ پرداختی برای روز تعطیل برنامهریزی نمیشود.
کارشمهلت پاسخ را به ساعت کاری میشمارد، نه به ساعت دیواری.
عملیاتهای API
از چه چیزهایی استفاده میکند
نتیجهمهلتهایی که با تعطیلات و پایان وقت اداری درست جلو میروند.
taghvim_create_scheduleکارشفقط از راه ابزارهای MCP و در حد اختیارش زمانبندی میکند.
عملیاتهای API
از چه چیزهایی استفاده میکند
نتیجههر اجرا رسید دارد و هیچ کار پنهانی در میان نیست.
سازمانی
مزایا
مزیت ۱: زمان مهندسی
بهجای نگهداری اینها:
فقط یک سکو را به محصولتان وصل میکنید.
مزیت ۲: یکدستی
دیگر هیچکدام از اینها جداگانه حساب نمیکند:
مزیت ۳: عرضهٔ سریعتر
مزیت ۴: ریسک عملیاتی کمتر
مزیت ۵: آماده برای عاملها
بازگشت سرمایه
قرار نیست ما در هر حالتی از کد داخلی ارزانتر باشیم. قرار است هزینهٔ ساخت، نگهداری، یکدستی و ریسک زیرساخت زمان را دیدنی و قابل مقایسه کنیم.
همهٔ عددها از ورودیهای خود شما حساب میشوند؛ هزینهٔ خرابیها و رخدادها در این مدل نیامده است.
کارهای عقبافتاده
اطمینانپذیری
مقایسه
| قابلیت | کتابخانهٔ تاریخ شمسی | نرمافزار نوبتدهی | زیرساخت زمان ما |
|---|---|---|---|
| شمسی و میلادی | دارد | گاهی | دارد |
| تعطیلات | محدود | گاهی | دارد |
| روزهای کاری | محدود | محدود | دارد |
| زمانبندی منابع | — | دارد | دارد |
| API رزرو | — | وابسته به محصول | دارد |
| سررسیدها | — | — | دارد |
| تکرار | در حد کتابخانه | دارد | دارد |
| زمانبندی عاملها | — | — | دارد |
| MCP | — | — | دارد |
| ویجتها | — | دارد | دارد |
| وبهوک و رویداد | — | گاهی | دارد |
| ساعت آزمایشی | — | — | دارد |
| ساختن محصول خودتان روی آن | محدود | محدود | بله |
ما جای محصول شما را نمیگیریم؛ زیرساختی هستیم که محصول شما روی آن ساخته میشود.
قیمتگذاری
بدون کارت بانکی
برای توسعهدهندگان مستقل و محصولات کوچکِ در حال اجرا.
با ما تماس بگیرید
با ما تماس بگیرید
با ما تماس بگیرید
با ما تماس بگیرید
شروع رایگان است؛ برای پلنهای بالاتر و سازمانی با ما تماس بگیرید.
برای توسعهدهندگان
POST /v1/reservationsawait taghvim.reservations.create({...})taghvim.reservations.create(...)taghvim reservation createtaghvim_create_reservation<taghvim-booking></taghvim-booking>رابط عوض میشود؛ قرارداد عوض نمیشود.
داشبورد
ten_acmeدادهٔ نمایشی۱٫۲۸ از ۲ میلیون عملیات
taghvim.event.reservation.confirmed.v1taghvim.event.schedule.triggered.v1taghvim.event.deadline.created.v1تقویم گوگل ✓وبهوکها ✓
taghvim.event.reservation.confirmed.v1۲۰۰taghvim.event.deadline.overdue.v1۲۰۰taghvim.event.schedule.triggered.v1۵۰۳، سپس ۲۰۰taghvim.event.notification.delivered.v1۲۰۰نمای محصول
این نماها نمونههای تعاملیاند: انتخاب تاریخ در یک برنامهٔ بانکی، نمایش یادآوری و استفاده از ابزارهای توسعه. نمایش آنها به معنای فعالبودن ارسال پیام یا SDK برای همهٔ کاربران نیست.
بانک نمونهنمونه
انجام انتقال
سلام خانم رضایی،
قرارداد نمونهی ۱۲۴۰ روز سهشنبه ۳ آذر ۱۴۰۵ سررسید میشود. این یادآور ۳ روز کاری پیش از سررسید فرستاده شده است.
قرارداد ۱۲۴۰: ۳ آذر ۱۴۰۵
جستوجو
«رزروهای لغوشدهی هفتهی گذشته برای اتاق ۳»
rsv_8f21اتاق ۳لغوشده۱۴۰۵/۰۸/۲۴، ساعت ۱۰:۰۰rsv_8f37اتاق ۳لغوشده۱۴۰۵/۰۸/۲۶، ساعت ۱۴:۳۰rsv_9a04اتاق ۳لغوشده۱۴۰۵/۰۸/۲۸، ساعت ۰۹:۰۰«سررسیدهای فعال قراردادها در این هفته»
dl_4410قرارداد ۱۲۴۰فعال۱۴۰۵/۰۹/۰۱، ساعت ۲۳:۵۹dl_4418قرارداد ۹۸۲فعال۱۴۰۵/۰۹/۰۲، ساعت ۲۳:۵۹dl_4431قرارداد ۱۳۰۵فعال۱۴۰۵/۰۹/۰۴، ساعت ۲۳:۵۹«اجراهای ناموفق عاملها در ماه جاری»
run_7c12عامل وصولناموفق۱۴۰۵/۰۸/۲۷، ساعت ۰۹:۰۰run_7d40عامل تطبیقناموفق۱۴۰۵/۰۸/۲۹، ساعت ۱۸:۰۰بازارچه
روی هر بسته بزنید تا محتوایش را ببینید.
بازارچه برای گسترش زیستبوم است، نه شرطی برای اینکه از روز اول بتوانید از ما استفاده کنید.
سناریوهای نمونه
اینها سناریوهای فرضیاند، نه نظر یا تجربهٔ مشتری واقعی.
پرسشها
نه. ما زیرساختی هستیم برای ساختن قابلیتهای زمان و زمانبندی درون محصولهای دیگر.
نه. اولویت طراحی ما ایران است، اما مدل زمانی ما شمسی، میلادی و قمری را پوشش میدهد.
نه. ویجتها اختیاریاند. پس از دریافت دسترسی معتبر میتوانید از API استفاده کنید و رابط کاربری خودتان را بسازید؛ وضعیت عرضهٔ SDK و MCP جداگانه اعلام میشود.
MCP رابط برنامهریزیشده برای استفادهٔ کنترلشدهٔ عاملهای هوشمند از قابلیتهای زمانی است. دامنهٔ عملیات و زمان عرضه پس از تأیید اعلام میشود.
اتصال به تقویم گوگل و Outlook در نقشهٔ محصول است. پیش از استفاده، باید وضعیت عرضه و مجوزهای هر اتصالدهنده تأیید شود.
ما زیرساختی هستیم که میشود محصولی مثل آنها را رویش ساخت؛ خودمان لزوماً نرمافزار نوبتدهی آماده برای کسبوکارها نیستیم.
با بستههای تقویم نسخهدار، همراه با منشأ داده و امکان بازنویسی برای هر سازمان.
برای عملیات تغییردهنده، شناسهٔ درخواست و سازوکار جلوگیری از تکرار در نظر گرفته شده است. رفتار هر عملیات باید با تست همان عملیات تأیید شود.
بله، پیشنمایش ساعت آزمایشی در همین صفحه وجود دارد. محیط Sandbox دارای حساب و کلید API، مسیر فعالسازی جداگانهای دارد.
قابلیتهایی مانند جداسازی مشتریان، سیاستهای دسترسی و حسابرسی در طراحی سازمانی پیشبینی شدهاند؛ استفادهٔ عملیاتی هرکدام به تأیید و فعالسازی نیاز دارد.
با API تقویم شروع کنید. وقتی محصولتان بزرگ شد، همین زیرساخت در زمانبندی، رزرو، سررسید، گردشکار و عاملهای هوشمند همراهتان است.
بدون کارت بانکی · محیط آزمایشی مستقل · تأیید ایمیل و کلید ۳۰روزه
شمارهٔ پیگیری: