به مستندات API کاما خوش آمدید
این مستندات راهنمای کامل استفاده از API سیستم کاما است. در اینجا میتوانید با مفاهیم، تعاریف، نوع دادهها، نحوه احراز هویت و تمامی endpointهای API آشنا شوید.
ساختار مستندات
- مفاهیم سیستم — آشنایی با مفاهیم پایه و دامنه سیستم
- تعاریف — واژهنامه و اصطلاحات تخصصی
- انواع دادهها — فرمتهای رایج داده در API
- احراز هویت — نحوه احراز هویت و دریافت توکن
- شروع سریع — شروع سریع کار با API
اطلاعات کلی
| ویژگی | توضیح |
|---|---|
| Base URL | /api |
| فرمت درخواستها | application/json |
| فرمت پاسخها | application/json |
| احراز هویت | Bearer Token |
| نسخه API | 1.0 |
قراردادهای عمومی
شناسه خطاها
پیامهای خطا در قالب زیر برمیگردند:
{
"success": false,
"errors": ["پیام خطا"]
}
صفحهبندی
پاسخ endpointهایی که لیست برمیگردانند شامل اطلاعات صفحهبندی است:
{
"records": [...],
"meta": {
"total": 100,
"current_page": 1,
"per_page": 20
}
}
تاریخها
تاریخها در API به فرمت jalali date standard (پیشفرض) یا Gregorian قابل ارسال هستند. فرمت پیشفرض: YYYY-MM-DD.