انتقل إلى المحتوى
تجربة مجانية 14 يومًا، بلا بطاقة9 لغات176 نوع عمل · 50 تطبيقًا
AR· USD
جرّب عرضًا حيًاابدأ التجربة المجانية

التكاملات و REST API: كيف يعمل

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

الدرس 2 من 9 · كيف يعمل

  • حوالي 3 دقيقة
  • System → Integrations → Integrations & API

كيف يعمل

  1. «System → Integrations → Integrations & API» تعرض أربعة أرقام في الأعلى: «Active keys»، «Endpoints»، «Delivered (7 d)» و«Failed». تحتها اللوحات «API keys»، «Webhook endpoints» و«Event catalog».

  2. اضغط «Create key»، وأعطه اسمًا يوضح أين يُستخدم، وحدّد نطاقاته (scopes)، وتاريخ انتهاء إن أردت. النطاق هو حق القراءة أو الكتابة لنوع واحد من السجلات. الكتابة تشمل القراءة.

  3. المفتاح الجديد يُعرض مرة واحدة تحت «Your new API key». انسخه فورًا: لا تُحفظ منه إلا بصمة، لذلك لا يمكن عرضه مرة أخرى.

  4. النظام الآخر يرسل المفتاح مع كل طلب. يستطيع سرد وقراءة العملاء والعملاء المحتملين وعروض الأسعار والفواتير والطلبات والمنتجات، ويستطيع إنشاء عملاء وعملاء محتملين ومسودات عروض أسعار ومسودات فواتير.

  5. العميل المحتمل الذي يُنشأ عبر API يُطلق الرسائل نفسها التي يطلقها نموذج الموقع. عروض الأسعار والفواتير التي تُنشأ عبر API تكون دائمًا مسودات، وتُحسب ضريبتها كما في محرر لوحة الإدارة. API لا يرسلها أبدًا ولا يعلّمها كمدفوعة.

  6. صف كل مفتاح يعرض نطاقاته، ومن أنشأه، وعدد الطلبات، وآخر استخدام، مع الشارة «Active» أو «Expired» أو «Revoked». زر «Revoke» يوقف المفتاح فورًا.

  7. «API docs» يفتح المرجع الكامل للمطوّر، و«Delivery log» يفتح قائمة إرسالات webhook.

أين تجده

إعدادات تغيّره

قائمة التحقق

قبل أن تنتقل، تأكد أنك تستطيع:

  • فتح System → Integrations → Integrations & API
  • System → Integrations → Integrations & API تعرض أربعة أرقام في الأعلى: Active keys، Endpoints، Delivered (7…
  • اضغط Create key، وأعطه اسمًا يوضح أين يُستخدم، وحدّد نطاقاته (scopes)، وتاريخ انتهاء إن أردت.
  • المفتاح الجديد يُعرض مرة واحدة تحت Your new API key.
  • النظام الآخر يرسل المفتاح مع كل طلب.

نصائح وأخطاء شائعة

  • ضاع منك مفتاح؟ لا يمكن استرجاعه. ألغِ المفتاح القديم وأنشئ مفتاحًا جديدًا.
  • رفض طلب بسبب نطاق ناقص يعني أن المفتاح أُنشئ بدون ذلك الحق. أنشئ مفتاحًا جديدًا مع تحديد ذلك النطاق.
  • يستطيع المفتاح إرسال 300 طلب دفعة واحدة ثم 5 طلبات في الثانية. النظام الذي يطلب أسرع من ذلك يُطلب منه الانتظار، وتكرار الرفض من عنوان واحد قد يؤدي إلى حظر مؤقت.
  • عامل المفتاح مثل كلمة المرور. أعطِ كل نظام متصل مفتاحًا خاصًا به، حتى تستطيع إلغاء واحد دون إيقاف البقية.