الغرض منها
تتيح واجهة البرمجة (API) لنظام آخر العمل مع سجلات تدريب شركة واحدة دون أن يصدّر أحد جدول بيانات. أكثر البدايات شيوعًا:
- يضيف نظام الموارد البشرية الموظفين الجدد مع أدوارهم، فتُسند خطة التدريب دوراتهم؛
- تعرض الشبكة الداخلية أو لوحة المتابعة من أتمّ تدريبه ومن تستحق شهادته التجديد؛
- يحتفظ نظام الرواتب أو ملف الموظف بأرقام الشهادات.
وهي مشمولة للشركات التي اشترت دورة مدفوعة أو لديها خطة فعّالة.
أنشئ مفتاحًا
- افتح الشركة، ثم التكاملات ثم API.
- اختر إنشاء مفتاح، وسمّه باسم النظام الذي سيستخدمه، واختر موعد انتهائه.
- حدّد الصلاحيات التي يحتاجها ذلك النظام فقط. القراءة لا تغيّر شيئًا؛ وصلاحية إنشاء الموظفين وتحديثهم هي الوحيدة التي تكتب.
- انسخ المفتاح عند ظهوره، فهو يظهر مرة واحدة: احفظه في إعدادات الأسرار لدى ذلك النظام.
جدير بالمعرفة
مالك الحساب وحده يستطيع إنشاء المفاتيح وتدويرها وإلغاءها. يصل المفتاح إلى شركة واحدة، ويمكن أن يكون للشركة حتى خمسة مفاتيح فعّالة.
أرسل الطلب الأول
تُرسَل الطلبات كلها إلى https://training.shogconsulting.com/api/v1 مع المفتاح بصيغة Bearer. يعرض تبويب البدء السريع الطلب الدقيق لشركتك جاهزًا للنسخ.
- تُرجع القوائم حتى 100 سجل في الصفحة؛ اتبع
nextCursorللصفحة التالية. - يحمل كل طلب يضيف موظفًا أو يغيّره
Idempotency-Key، فلا تُنشئ إعادة المحاولة الشخص نفسه مرتين. - لكل مفتاح 60 طلبًا في الدقيقة، وللشركة 120 طلبًا في المجموع. ويبيّن الرد
429مدة الانتظار.
حافظ على أمان المفاتيح
- احفظ المفاتيح على خادم، ولا تضعها أبدًا في صفحة ويب أو جدول بيانات أو لقطة شاشة.
- تدوير السر يُصدر سرًا جديدًا ويُبقي القديم صالحًا 24 ساعة ريثما تنتقل إليه.
- إلغاء يوقف المفتاح فورًا.
- يعرض الاستخدام طلبات آخر 30 يومًا، لترى ما فعله كل مفتاح.
اقرأ بعدها
- استقبل التحديثات عبر خطافات الويبدع شوق تُعلم نظامك لحظة إضافة موظف أو إتمام دورة أو إصدار شهادة.
- استخدم شوق في Claude أو ChatGPTاربط مساعدك الذكي بسجلات تدريب شركة واحدة واسأله بلغة عادية. للقراءة فقط.
