85,057 عرضًا · 62,076 برنامجًا
مرجع تقني

مرجع API v1

المصادقة، النقاط النهائية، المعاملات، أمثلة curl وردود JSON. الأساس: جميع الروابط نسبية إلى أصل الإنتاج.

المصادقة

أرسِل token الشريك الخاص بك في إحدى هذه الترويسات HTTP في كل طلب (باستثناء الكتالوج العام):

Authorization: Bearer <token>
# ou
X-Api-Key: <token>

أمثلة الطلبات (curl) والاستجابات (JSON) مقدَّمة كما هي في جميع اللغات — فهي بيانات تقنية.

النقاط النهائية

GET/api/v1عام

كتالوج موثَّق ذاتيًا لواجهة API (عام، دون token).

مثال على الطلب

curl "https://www.superalternance.com/api/v1"

مثال على الرد

{
  "name": "superalternance API partenaires",
  "version": "1",
  "authentication": { "type": "bearer", "description": "…" },
  "endpoints": [ … ]
}
GET/api/v1/suggestيتطلب token

إكمال تلقائي «مهنة أو تكوين» لشريط بحث.

المعاملات

المعاملالنوعمطلوبالوصف
qstringنعمالنص المُدخَل (≥ حرفان).
limitintلاعدد الاقتراحات (1–20، الافتراضي 8).

مثال على الطلب

curl -H "Authorization: Bearer $TOKEN" \
  "https://www.superalternance.com/api/v1/suggest?q=boul&limit=5"

مثال على الرد

{
  "query": "boul",
  "suggestions": [
    { "kind": "rome", "value": "Boulanger", "secondary": "Métier" },
    { "kind": "formation", "value": "CAP Boulanger", "secondary": "CFA des métiers" }
  ]
}
GET/api/v1/placesيتطلب token

إكمال تلقائي للأماكن: الأقاليم والمحافظات والبلديات.

المعاملات

المعاملالنوعمطلوبالوصف
qstringنعمالنص المُدخَل (≥ حرفان).
limitintلاعدد الاقتراحات (1–12، الافتراضي 8).

مثال على الطلب

curl -H "Authorization: Bearer $TOKEN" \
  "https://www.superalternance.com/api/v1/places?q=lyon"

مثال على الرد

{
  "query": "lyon",
  "suggestions": [
    { "kind": "city", "value": "Lyon", "secondary": "69001 · Rhône", "lat": 45.758, "lng": 4.835 }
  ]
}
GET/api/v1/jobs/latestيتطلب token

أحدث عروض التناوب المنشورة، مع تصفية اختيارية حسب المكان.

المعاملات

المعاملالنوعمطلوبالوصف
lieustringلاالجهة / المحافظة / البلدية.
latfloatلاخط العرض (بحث بالنطاق).
lngfloatلاخط الطول (بحث بالنطاق).
radiusfloatلانصف القطر بالكيلومتر (الافتراضي 30).
limitintلاعدد العروض (1–100، الافتراضي 20).

مثال على الطلب

curl -H "Authorization: Bearer $TOKEN" \
  "https://www.superalternance.com/api/v1/jobs/latest?lieu=Bordeaux&limit=10"

مثال على الرد

{
  "filters": { "lieu": "Bordeaux" },
  "total": 10,
  "jobs": [
    { "id": "…", "title": "Développeur web en alternance", "subtitle": "Acme · Bordeaux",
      "city": "Bordeaux", "latitude": 44.84, "longitude": -0.58,
      "labels": ["Apprentissage"], "url": "https://www.superalternance.com/fr/offres/…" }
  ]
}
GET/api/v1/jobs/{id}يتطلب token

تفاصيل كاملة لعرض: العقد، صاحب العمل، الموقع، التقديم.

المعاملات

المعاملالنوعمطلوبالوصف
idpathنعممعرّف العرض (حقل `id` المُعاد من البحث).

مثال على الطلب

curl -H "Authorization: Bearer $TOKEN" \
  "https://www.superalternance.com/api/v1/jobs/abc123"

مثال على الرد

{
  "job": {
    "id": "abc123", "title": "Boulanger en alternance",
    "contractTypes": ["Apprentissage"], "duration": "24 mois",
    "location": { "city": "Lyon", "zipCode": "69003", "region": "Auvergne-Rhône-Alpes" },
    "company": { "name": "Maison Dupain", "siret": "…", "siren": "…" },
    "apply": { "email": null, "url": "…" }
  }
}
GET/api/v1/formations/{id}يتطلب token

تفاصيل كاملة لتكوين: الشهادة، RNCP، الهيئة (CFA)، الوتيرة.

المعاملات

المعاملالنوعمطلوبالوصف
idpathنعممعرّف التكوين (حقل `id` المُعاد من البحث).

مثال على الطلب

curl -H "Authorization: Bearer $TOKEN" \
  "https://www.superalternance.com/api/v1/formations/xyz789"

مثال على الرد

{
  "formation": {
    "id": "xyz789", "title": "CAP Boulanger", "diploma": "CAP",
    "rncpCode": "RNCP…", "targetDiplomaLevel": "3",
    "location": { "city": "Lyon", "region": "Auvergne-Rhône-Alpes" },
    "cfa": { "name": "CFA des métiers", "siret": "…" }
  }
}
GET/api/v1/companies/{siret}يتطلب token

ملف صاحب العمل حسب SIRET وقائمة بعروض التناوب المفتوحة الخاصة به.

المعاملات

المعاملالنوعمطلوبالوصف
siretpathنعمSIRET مكوَّن من 14 رقمًا.

مثال على الطلب

curl -H "Authorization: Bearer $TOKEN" \
  "https://www.superalternance.com/api/v1/companies/12345678901234"

مثال على الرد

{
  "company": {
    "siret": "12345678901234", "siren": "123456789", "name": "Maison Dupain",
    "size": "10 à 19 salariés", "nafCodes": ["1071C"],
    "location": { "city": "Lyon", "region": "Auvergne-Rhône-Alpes" },
    "openJobsCount": 3, "openJobs": [ … ]
  }
}
GET/api/v1/statsيتطلب token

إحصائيات مُجمَّعة للمنصة (+ عدادات حسب المهنة).

المعاملات

المعاملالنوعمطلوبالوصف
metierstringلاإذا قُدِّم، يضيف العدادات الخاصة بهذه المهنة.

مثال على الطلب

curl -H "Authorization: Bearer $TOKEN" \
  "https://www.superalternance.com/api/v1/stats?metier=boulanger"

مثال على الرد

{
  "jobs": 17658, "formations": 58596, "cfa": 6923,
  "lastSyncAt": "2026-06-04T21:01:06.369Z",
  "metier": { "name": "boulanger", "jobs": 42, "formations": 120, "diplomas": 8 }
}

رموز الأخطاء

تتبع الأخطاء شكلًا موحدًا: { "error": { "code": "…", "message": "…" } }.

الحالةالرمزالمعنى
400bad_requestمُعامِل مفقود أو غير صالح.
401unauthorizedtoken الوصول مفقود.
403forbiddentoken الوصول غير صالح.
404not_foundالمورد غير موجود.
500internalخطأ في الخادم أو واجهة API غير مهيَّأة.

لوكلاء الذكاء الاصطناعي

يصف كتالوج JSON العام جميع النقاط النهائية والمعاملات والأخطاء بطريقة قابلة للقراءة آليًا، دون مصادقة. نقطة انطلاق مثالية لوكيل يكتشف واجهة API.

فتح كتالوج JSON

مرجع API v1 — النقاط النهائية والمعاملات والأمثلة | superalternance · superalternance