مفاتيح API¶
هنا ينشئ المسؤول المفاتيح التي توثّق الاستدعاءات إلى واجهة Clix البرمجية (REST API)، ويلغيها.
في باقة الأعمال فقط
الوصول إلى الواجهة البرمجية (REST API) متاح في باقة أعمال. في باقتي مجاني واحترافي تعرض هذه الشاشة "الوصول إلى واجهة برمجة التطبيقات ميزة في باقة الأعمال" وزر عرض الباقات بدلًا من قائمة المفاتيح. انظر الباقات والحدود والاستخدام العادل.
من. المسؤول فقط. لا يرى أي دور آخر مفاتيح API في القائمة الجانبية.
ما تراه¶

- إنشاء مفتاح: يفتح مربع حوار إنشاء مفتاح API.
- اقرأ دليل التكامل: يفتح دليل المطوّرين على goclix.ai، بلغتك.
- القائمة، سطر لكل مفتاح:
| العمود | ما يعرضه |
|---|---|
| الاسم | اسم المفتاح الذي أعطيته له، مثل "تكامل نظام ERP" |
| مستوى الوصول | مثل محاسب (الفواتير والإشعارات والتقارير) |
| المفتاح | بداية المفتاح، clix_ وبضعة أحرف. لا يُعرض المفتاح كاملًا مرة أخرى بعد إنشائه. |
| تاريخ الإنشاء | تاريخ إنشائه |
| آخر استخدام | لم يُستخدم حتى يُجري المفتاح أول استدعاء |
| إلغاء: يوقف المفتاح |
دورة حياة المفتاح¶
flowchart RL
A["إنشاء مفتاح"] --> B["انسخ مفتاحك الآن<br/>يُعرض مرة واحدة"]
B --> C["يستدعي نظامك<br/>واجهة Clix البرمجية به"]
C --> D{"تسرّب أو ضاع أو<br/>لم تعد بحاجة إليه؟"}
D -->|"استبدله"| E["إنشاء مفتاح<br/>للمفتاح الجديد"]
E --> F["إلغاء المفتاح<br/>على المفتاح القديم"]
D -->|"أوقفه"| F
لا يوجد زر لتدوير المفتاح. لتدويره، أنشئ المفتاح الجديد، وانقل نظامك إليه، ثم ألغِ القديم.
المهام¶
إنشاء مفتاح¶
لماذا. يحتاج نظامك إلى إصدار الفواتير أو قراءتها دون أن يسجّل شخص الدخول.
من. المسؤول، في باقة الأعمال.
- افتح مفاتيح API واضغط إنشاء مفتاح.
- أدخل اسم المفتاح بحيث يدل على مكان استخدامه، مثل "تكامل نظام ERP".
- اختر مستوى الصلاحية.
- اضغط إنشاء المفتاح.
- انسخ المفتاح من انسخ مفتاحك الآن.
- اضغط لقد حفظته.

| مستوى الصلاحية | لمن |
|---|---|
| عرض الفواتير (قراءة فقط) | أدوات التقارير التي تقرأ فقط |
| إنشاء الفواتير وعرضها | نظام يُصدر الفواتير. وهو الافتراضي. |
| محاسب (الفواتير والإشعارات والتقارير) | نظام يحتاج أيضًا إلى الإشعارات الدائنة والمدينة والتقارير |
النتيجة. يعمل المفتاح فورًا، ويستدعي الواجهة البرمجية نيابة عن منشأتك.
حفظه بأمان¶
المفتاح يُعرض مرة واحدة. "هذه هي المرة الوحيدة التي يُعرض فيها المفتاح كاملاً. احفظه في مكان آمن — نحتفظ بالتجزئة فقط ولا يمكننا عرضه مرة أخرى." إذا ضاع، فألغِه وأنشئ غيره.
من يحمل المفتاح يستطيع التصرف باسم منشأتك بمستوى صلاحيته. عامِله ككلمة مرور:
- لا تضعه أبدًا في مستودع شيفرة، ولا تلصقه في تذكرة دعم؛
- أعطِ كل نظام مفتاحه الخاص، لتستطيع إلغاء أحدها دون إيقاف الباقي؛
- ألغِه فورًا إذا شككت في تسرّبه.
إلغاء مفتاح¶
من. المسؤول.
- في مفاتيح API، اضغط إلغاء في سطر المفتاح.
- في إلغاء هذا المفتاح؟، اضغط إلغاء المفتاح. أما الاحتفاظ بالمفتاح فيغلق مربع الحوار دون إلغاء.
يذكر مربع الحوار المفتاح ببادئته، وينبّه إلى أن أي تكامل يستخدمه "سيتوقف عن العمل خلال دقيقة. لا يمكن التراجع عن هذا الإجراء."
النتيجة. "تم إلغاء المفتاح"، ويخرج المفتاح من القائمة. أي استدعاء به يُجاب بـ 401 Invalid or revoked API key. ولا تتأثر الفواتير التي صدرت به: فهي فواتير حقيقية، وتبقى معتمدة أو مُبلَّغًا عنها.
الحدود¶
لاستدعاءات الواجهة البرمجية حد لمعدل الطلبات في الدقيقة. الاستدعاء الذي يتجاوز الحد يُجاب بـ 429. انظر الاستخدام والحصص والأخطاء وحدود معدل الطلبات.
إذا خرجت منشأتك من باقة الأعمال، يتوقف كل مفتاح عن العمل في استدعائه التالي، ويُجاب بـ 403 API access is not included in your current plan. لا تُلغى المفاتيح: تعود إلى العمل حين يعود الوصول إلى الواجهة البرمجية، وتستطيع في الأثناء عرضها وإلغاءها.
صفحات ذات صلة¶
- المصادقة ومفاتيح API: كيف تستخدم المفتاح في الطلب
- البدء السريع
- الباقات والحدود والاستخدام العادل