تتيح REST API الوصول البرمجي إلى بيانات شركتك. وهي مخصصة للمطورين الذين يبنون تكاملًا؛ ولا تحتاج إليها في الاستخدام اليومي.
- مرجع API: المرجع الكامل متاح للعامة على /docs/api في عنوان مساحة عملك، مع مستند OpenAPI على /docs/api/openapi.yaml و/docs/api/openapi.json. ويرتبط به API و Webhooks في الإعدادات.
- عنوان URL الأساسي: يظهر أعلى API و Webhooks. وهو ينتهي بـ /api/v1.
- المصادقة: أرسل الترويسة Authorization: Bearer متبوعة برمزك، وAccept: application/json.
- الاستجابات: JSON فقط. تُغلَّف السجلات المفردة في data؛ وتضيف القوائم meta وlinks للتقسيم إلى صفحات بالمؤشر (المعاملان limit وcursor، حتى 100 في الصفحة).
- إعادة المحاولة الآمنة: أرسل ترويسة Idempotency-Key في طلبات POST. تكرار الطلب نفسه بالمفتاح نفسه يُعيد الاستجابة المخزنة بدلًا من إنشاء سجل ثانٍ. وتُحفظ المفاتيح لمدة 24 ساعة.
- حد المعدل: 120 طلبًا في الدقيقة لكل رمز. تعرض الترويستان X-RateLimit-Limit وX-RateLimit-Remaining موقفك؛ وعند تجاوز الحد تحصل على 429 مع ترويسة Retry-After.
ما الذي يمكن للطلب فعله
لا ينجح الطلب إلا عندما يملك الرمز الصلاحية (مثل invoices:write) ويملك مستخدم الرمز الصلاحية المطابقة في التطبيق. وتنطبق قواعد العمل نفسها كما على الشاشة، لذا لا يمكن تعديل فاتورة مُصدرة عبر API أيضًا.
أدلة ذات صلة
اسأل عن المنتج
اسأل عما يمكن للبرنامج فعله، أو كيف تتم مهمة ما، أو الدول واللغات التي يدعمها. تأتي الإجابات من هذه الأدلة.
جارٍ التفكير…
مساعد الذكاء الاصطناعي غير متاح الآن. ابحث في الأدلة أو تحدّث مع فريقنا. تواصل مع الدعم
قد يخطئ الذكاء الاصطناعي. تحقق من الأدلة المرتبطة.