الربط مع أي منصة خارجية عبر واجهة برمجة التطبيقات (API)

واجهة برمجة التطبيقات (API) هي طريقة تتيح للأنظمة والتطبيقات تبادل البيانات مع دفترة برمجيًا، دون إدخالها يدويًا. وتدعم دفترة الربط عبر API مع أي منصة أو تطبيق خارجي، مثل المتاجر الإلكترونية، وتطبيقات الحجوزات، وأنظمة نقاط البيع، وبرامج إدارة العملاء، والمواقع والتطبيقات الخاصة بنشاطك.

فإذا كانت المنصة التي تستخدمها غير مرتبطة بدفترة بربط جاهز، يمكن لفريقك التقني أو مطوّر المنصة ربطها بدفترة من خلال API، باتباع وثائق API لدفترة.

ماذا يمكنك أن تفعل بالـ API؟

تتيح API للمنصة الخارجية أن تقرأ البيانات من حسابك في دفترة، أو تضيفها، أو تعدّلها، أو تحذفها، حسب ما توفره وثائق API. ومن أمثلة الاستخدام:

متى تستخدم API؟

• عندما تكون المنصة غير مرتبطة بدفترة بربط جاهز.
• عندما تحتاج ربطًا مخصصًا يناسب طريقة عملك، مثل نقل بيانات معينة فقط أو في توقيت معين.
• عندما تبني تطبيقًا أو موقعًا خاصًا بنشاطك وتريد أن يعمل مع بيانات دفترة.

ربط دفترة مع برنامج أو منصة أخرى

إذا أردت ربط دفترة مع برنامج أو منصة أخرى تستخدمها، مثل برنامج إدارة فنادق أو عيادات أو متجر أو نظام محاسبي آخر، ولم يكن لها ربط جاهز مع دفترة، فيمكن ربطها عبر API، بشرط أن يدعم البرنامج الآخر الربط عبر API أيضًا.

فالربط يتم بين نظامين: دفترة توفر API ووثائقه، والبرنامج الآخر يجب أن يتيح طريقة لإرسال بياناته أو استقبالها برمجيًا، مثل API خاص به أو إمكانية إضافة ربط مخصص. وإذا كان البرنامج الآخر لا يدعم ذلك، فلا يمكن الربط المباشر بينهما.

خطوات التحقق قبل الربط

1. اسأل مزوّد البرنامج الآخر: هل يدعم الربط عبر API، أو هل يمكنه الربط مع برنامج محاسبي خارجي؟
2. حدد البيانات التي تريد نقلها، مثل الفواتير أو العملاء أو المدفوعات، واتجاهها: من البرنامج إلى دفترة أو العكس.
3. اتفق مع مطوّر ينفذ الربط، سواء فريقك التقني أو فريق البرنامج الآخر.
4. أنشئ مفتاح API من دفترة وأرسله للمطوّر مع رابط وثائق API لدفترة.

إنشاء مفتاح API

مفتاح API هو رمز سري تستخدمه المنصة الخارجية لتتصل بحسابك. أنشئ مفتاحًا منفصلًا لكل منصة.

1. افتح API، أو من القائمة الرئيسية اضغط الإعدادات ثم API.
2. اضغط API Keys.
3. اضغط Generate Api Key.
4. في حقل الاسم اكتب اسم المنصة التي ستربطها، مثل: المتجر الإلكتروني.
5. اضغط أرسل.
6. يظهر المفتاح في قائمة API Keys؛ انسخه وأرسله للمطوّر بطريقة آمنة.

ويرسل المطوّر المفتاح مع كل طلب في الترويسة (Header) باسم APIKEY، والتفاصيل في وثائق API.

تقييد صلاحيات المفتاح

يمكنك تحديد ما يُسمح للمفتاح بالوصول إليه، حتى لا تصل المنصة إلا للبيانات التي تحتاجها:

1. من API Keys اضغط Edit Roles بجوار المفتاح.
2. اختر نوع القاعدة: only allow (السماح بالروابط المحددة فقط) أو only block (منع الروابط المحددة فقط).
3. اكتب روابط API المقصودة، كل رابط في سطر.
4. اضغط حفظ.

وثائق API

تشرح الوثائق كل ما يحتاجه المطوّر للربط: طريقة الاتصال، والروابط المتاحة لكل وحدة، والبيانات المطلوبة في كل طلب، وأمثلة الطلبات والردود.

• الوثائق العامة: وثائق API لدفترة.
• ومن داخل حسابك: API ← API Docs.

حماية مفاتيح API

• المفتاح يعطي صلاحية الوصول لبيانات حسابك؛ لا تنشره ولا ترسله إلا للمطوّر المسؤول.
• أنشئ مفتاحًا لكل منصة، حتى تتمكن من إيقاف منصة واحدة دون التأثير على غيرها.
• قيّد صلاحيات المفتاح بالروابط التي تحتاجها المنصة فقط.
• احذف المفتاح فورًا من API Keys إذا توقفت عن استخدام المنصة أو شككت في تسريبه، ثم أنشئ مفتاحًا جديدًا.

أسئلة شائعة

هل يمكن ربط دفترة بمنصة ليس لها ربط جاهز؟

نعم، يمكن ربط دفترة بأي منصة عبر API، بشرط أن ينفذ مطوّر الربط على المنصة الخارجية باستخدام وثائق API.

هل يمكن ربط دفترة مع برنامج آخر مثل برنامج نزيل؟

لا يوجد ربط جاهز بين دفترة وبرنامج نزيل، لكن يمكن ربطهما عبر API إذا كان برنامج نزيل يدعم الربط عبر API أو الربط مع برامج محاسبية خارجية؛ تواصل مع مزوّد البرنامج للتأكد، ثم ينفذ مطوّر الربط باستخدام وثائق API لدفترة.

ما شرط ربط دفترة مع أي برنامج آخر؟

أن يدعم البرنامج الآخر الربط عبر API أيضًا، وأن ينفذ مطوّر الربط بين النظامين.

هل أحتاج مبرمجًا للربط عبر API؟

نعم، الربط يحتاج مطوّرًا أو فريقًا تقنيًا، أو مطوّر المنصة الخارجية نفسها.

أين أجد وثائق API؟

في وثائق API لدفترة، أو من داخل حسابك في الإعدادات ← API ← API Docs.

هل أستخدم نفس المفتاح لأكثر من منصة؟

يُفضل مفتاح منفصل لكل منصة، لتتحكم في صلاحياتها وتوقفها منفردة.

كيف أوقف ربط منصة؟

احذف مفتاحها من API Keys، فتتوقف عن الوصول لحسابك فورًا.

لا تظهر صفحة API عندي؟

تحتاج صلاحية تعديل الإعدادات العامه.