مرجع الـ API

تتيح لك واجهة برمجة تطبيقات InvoiceNests إنشاء وقراءة الفواتير، والعملاء، والمدفوعات، والمنتجات، والمصروفات الخاصة بمؤسستك. جميع الطلبات تستخدم HTTPS وتعيد البيانات بصيغة JSON.

مقدمة

مصادقة بنمط OAuth

قم بتبديل client_id + client_secret الخاص بك للحصول على رموز وصول قصيرة الأجل. يتم تجديد رموز التحديث في كل مرة يتم استخدامها.

تحقق بدون قاعدة بيانات

يتم التحقق من رموز وصول JWT محليًا باستخدام HMAC — وقت استجابة أقل من ميلي ثانية، بدون الحاجة للرجوع لقاعدة البيانات.

وصول 1 ساعة / تحديث 30 يوم

تدوم رموز الوصول لمدة ساعة واحدة. تدوم رموز التحديث لمدة 30 يومًا ويتم تجديدها عند كل استخدام.

اكتشاف إعادة الاستخدام

إذا تم إعادة استخدام رمز التحديث، يتم إبطال جميع الجلسات النشطة لذلك المفتاح فورًا.

البدء السريع — اجلب أول فاتورة في 4 خطوات

أنشئ مفتاح API

افتح الإعدادات → API → إنشاء مفتاح. اختر النطاقات التي يحتاجها التكامل (مثل read:invoices). ستحصل على Client ID (ak_live_…) و Secret Key (sk_live_…). المفتاح السري يُعرض مرة واحدة فقط — انسخه فورًا إلى مدير كلمات مرور.

Settings → API → Create Key

بدّل بياناتك للحصول على رمز وصول

أرسل طلب POST إلى /api/v1/auth/token مع client_id و client_secret و grant_type="client_credentials". الاستجابة تعطيك access_token صالح لساعة و refresh_token صالح لـ 30 يومًا.

Request

POST https://app.invoicenests.com/api/v1/auth/token
Content-Type: application/json

{
  "client_id":     "ak_live_…",      // public key
  "client_secret": "sk_live_…",      // secret key (shown once)
  "grant_type":    "client_credentials"
}

200 OK

{
  "access_token":  "eyJhbGciOiJIUzI1NiIs…",
  "token_type":    "Bearer",
  "expires_in":    3600,
  "refresh_token": "rt_live_…",
  "scope":         "read:invoices read:clients …"
}

استدعِ نقاط نهاية البيانات برمز الوصول

أضف الترويسة Authorization: Bearer ACCESS_TOKEN إلى كل طلب، مع استبدال ACCESS_TOKEN بالرمز من الخطوة 2. جميع نقاط نهاية البيانات تقع تحت /api/v1.

Request

GET https://app.invoicenests.com/api/v1/invoices
Authorization: Bearer <access_token>

جدّد الرمز قبل انتهاء صلاحيته

قبل انتهاء صلاحية access_token (ساعة واحدة)، أرسل refresh_token عبر POST إلى /api/v1/auth/refresh للحصول على زوج جديد. كل refresh_token يُستخدم مرة واحدة فقط — إذا أعدت استخدامه، ستُلغى جميع جلسات هذا المفتاح.

Request

POST https://app.invoicenests.com/api/v1/auth/refresh
Content-Type: application/json

{ "refresh_token": "rt_live_…" }

تستخدم React + TypeScript؟

كل نقطة نهاية في هذه الصفحة فيها مثال جاهز للنسخ بـ React + TS مع الأنواع كاملة. اضغط أيقونة React في تبويبات اللغات لعرضه.

مقدمة

إدارة مفاتيح الـ API

اطلع على الأسعار