85.057 Angebote · 62.076 Ausbildungen
Technische Referenz

Referenz API v1

Authentifizierung, Endpunkte, Parameter, curl-Beispiele und JSON-Antworten. Basis: Alle URLs sind relativ zum Produktionsursprung.

Authentifizierung

Übermitteln Sie Ihr Partner-Token in einem dieser HTTP-Header bei jeder Anfrage (außer beim öffentlichen Katalog):

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

Die Beispielanfragen (curl) und -antworten (JSON) werden in allen Sprachen identisch bereitgestellt — es handelt sich um technische Daten.

Endpunkte

GET/api/v1Öffentlich

Selbstdokumentierter Katalog der API (öffentlich, ohne Token).

Beispielanfrage

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

Beispielantwort

{
  "name": "superalternance API partenaires",
  "version": "1",
  "authentication": { "type": "bearer", "description": "…" },
  "endpoints": [ … ]
}
GET/api/v1/suggestToken erforderlich

Autovervollständigung „Beruf oder Ausbildung“ für eine Suchleiste.

Parameter

ParameterTypErforderlichBeschreibung
qstringJaEingegebener Text (≥ 2 Zeichen).
limitintNeinAnzahl der Vorschläge (1–20, Standard 8).

Beispielanfrage

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

Beispielantwort

{
  "query": "boul",
  "suggestions": [
    { "kind": "rome", "value": "Boulanger", "secondary": "Métier" },
    { "kind": "formation", "value": "CAP Boulanger", "secondary": "CFA des métiers" }
  ]
}
GET/api/v1/placesToken erforderlich

Autovervollständigung von Orten: Regionen, Departements und Gemeinden.

Parameter

ParameterTypErforderlichBeschreibung
qstringJaEingegebener Text (≥ 2 Zeichen).
limitintNeinAnzahl der Vorschläge (1–12, Standard 8).

Beispielanfrage

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

Beispielantwort

{
  "query": "lyon",
  "suggestions": [
    { "kind": "city", "value": "Lyon", "secondary": "69001 · Rhône", "lat": 45.758, "lng": 4.835 }
  ]
}
GET/api/v1/jobs/latestToken erforderlich

Neueste veröffentlichte Angebote für duales Studium, mit optionalem Ortsfilter.

Parameter

ParameterTypErforderlichBeschreibung
lieustringNeinRegion / Departement / Gemeinde.
latfloatNeinBreitengrad (Umkreissuche).
lngfloatNeinLängengrad (Umkreissuche).
radiusfloatNeinRadius in km (Standard 30).
limitintNeinAnzahl der Angebote (1–100, Standard 20).

Beispielanfrage

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

Beispielantwort

{
  "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 erforderlich

Vollständige Details eines Angebots: Vertrag, Arbeitgeber, Standort, Bewerbung.

Parameter

ParameterTypErforderlichBeschreibung
idpathJaKennung des Angebots (Feld `id`, das von der Suche zurückgegeben wird).

Beispielanfrage

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

Beispielantwort

{
  "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 erforderlich

Vollständige Details einer Ausbildung: Abschluss, RNCP, Einrichtung (CFA), Rhythmus.

Parameter

ParameterTypErforderlichBeschreibung
idpathJaKennung der Ausbildung (Feld `id`, das von der Suche zurückgegeben wird).

Beispielanfrage

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

Beispielantwort

{
  "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 erforderlich

Arbeitgeberprofil nach SIRET und Liste seiner offenen Angebote für duales Studium.

Parameter

ParameterTypErforderlichBeschreibung
siretpathJa14-stellige SIRET.

Beispielanfrage

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

Beispielantwort

{
  "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/statsToken erforderlich

Aggregierte Statistiken der Plattform (+ Zähler nach Beruf).

Parameter

ParameterTypErforderlichBeschreibung
metierstringNeinFalls angegeben, werden die für diesen Beruf spezifischen Zähler hinzugefügt.

Beispielanfrage

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

Beispielantwort

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

Fehlercodes

Die Fehler folgen einer einheitlichen Form: { "error": { "code": "…", "message": "…" } }.

StatusCodeBedeutung
400bad_requestParameter fehlt oder ist ungültig.
401unauthorizedZugriffstoken fehlt.
403forbiddenZugriffstoken ungültig.
404not_foundRessource nicht gefunden.
500internalServerfehler oder API nicht konfiguriert.

Für KI-Agenten

Der öffentliche JSON-Katalog beschreibt alle Endpunkte, Parameter und Fehler maschinenlesbar, ohne Authentifizierung. Der ideale Einstiegspunkt für einen Agenten, der die API entdeckt.

JSON-Katalog öffnen

API-Referenz v1 — Endpunkte, Parameter und Beispiele | superalternance · superalternance