English

شروع سریع

پیش‌نیازها

یک حساب کاربری فعال در سیستم کاما
آدرس سرور API

مراحل شروع

مرحله ۱: ورود به سیستم

ابتدا با استفاده از endpoint ورود، یک توکن دریافت کنید:

curl -X POST "https://example.com/api/auth/login" \
  -H "Content-Type: application/json" \
  -d '{"email": "admin@example.com", "password": "your-password"}'

مرحله ۲: دریافت اطلاعات کاربر

با توکن دریافتی، اطلاعات کاربر خود را دریافت کنید:

curl -X GET "https://example.com/api/auth/me" \
  -H "Authorization: Bearer {token}"

مرحله ۳: دریافت لیست مشتریان

curl -X GET "https://example.com/api/clients" \
  -H "Authorization: Bearer {token}"

مرحله ۴: ایجاد یک مشتری جدید

curl -X POST "https://example.com/api/clients" \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "شرکت نمونه",
    "type": "organization",
    "phone": "021-12345678"
  }'

خطاهای رایج

401 Unauthorized

توکن نامعتبر است یا منقضی شده است. مجدداً وارد شوید.

403 Forbidden

شما دسترسی لازم برای این عملیات را ندارید.

422 Validation Error

فیلدهای ارسالی معتبر نیستند. خطاهای اعتبارسنجی را بررسی کنید.

429 Too Many Requests

محدودیت نرخ را رعایت کنید. صبر کنید و دوباره تلاش کنید.

نکات مهم

توکن خود را در سمت کلاینت ذخیره کنید و در تمام درخواست‌ها ارسال کنید.
زمان انقضای توکن ۲۴ ساعت است. پس از آن نیاز به ورود مجدد دارید.
از کلید API برای دسترسی دائمی استفاده کنید.
تمام درخواست‌ها باید با هدر Content-Type: application/json باشند (مگر در موارد خاص).
تاریخ‌ها را به فرمت YYYY-MM-DD ارسال کنید.