الأتمتة والمطوّرون

REST API

اقرأ وأدِر الحملات والطلبات والمستخدمين برمجيًا.

تتيح API REST من PeekHire لبرنامجك العمل مع بيانات التوظيف لديك. إنها API قياسية تعتمد على HTTPS + JSON، لذا يمكن لأي لغة أو أداة قادرة على إرسال طلبات ويب استخدامها.

استكشف كل endpoint ومعامل ومخطط في مرجع OpenAPI التفاعلي:

افتح مرجع API

عنوان URL الأساسي وإدارة الإصدارات

الـ API لها إصدارات. تقع جميع endpoints تحت بادئة /api/v1 حتى لا تؤدي التغييرات المستقبلية إلى تعطيل تكاملك.

المصادقة

صادِق كل طلب باستخدام مفتاح API يُرسل كـ bearer token:

curl https://your-api-host/api/v1/campaigns \
  -H "Authorization: Bearer YOUR_API_KEY"

لا تضمّن أبدًا مفتاح API في كود يعمل على جهة العميل أو في مستودع عام.

ما الذي يمكنك الوصول إليه

تغطي API v1 كائنات التوظيف الأساسية:

الحملات — اعرض واسترجع الأدوار التي توظّف لها.
طلبات التقديم — اعرض واسترجع طلبات المرشحين.
المستخدمون — اعرض واسترجع أعضاء مساحة العمل لديك.

تكون الاستجابات بصيغة JSON وتتضمن الحقول التي تراها في التطبيق، مثل عنوان الحملة وحالتها أو مرحلة طلب التقديم ولغته.

الترقيم الصفحي والتصفية

تعيد endpoints الخاصة بالقوائم النتائج على صفحات. استخدم معاملات الترقيم الصفحي للتنقل بين مجموعات النتائج الكبيرة، وطبّق التصفية حيثما كانت مدعومة لجلب ما تحتاجه فقط.

الأخطاء

تستخدم API رموز حالة HTTP القياسية — 2xx للنجاح، و4xx للمشكلات في طلبك (مثل مفتاح مفقود أو غير صالح)، و5xx لأخطاء الخادم غير المتوقعة. تتضمن استجابات الأخطاء رسالة توضّح ما حدث.