85 057 offres · 62 076 formations
Référence technique

Référence API v1

Authentification, endpoints, paramètres, exemples curl et réponses JSON. Base : toutes les URL sont relatives à l'origine de production.

Authentification

Transmettez votre token partenaire dans l'un de ces en-têtes HTTP sur chaque requête (hors catalogue public) :

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

Les exemples de requêtes (curl) et de réponses (JSON) sont fournis à l'identique dans toutes les langues — ce sont des données techniques.

Endpoints

GET/api/v1Public

Catalogue auto-documenté de l'API (public, sans token).

Exemple de requête

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

Exemple de réponse

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

Autocomplétion « métier ou formation » pour une barre de recherche.

Paramètres

ParamètreTypeRequisDescription
qstringOuiTexte saisi (≥ 2 caractères).
limitintNonNombre de suggestions (1–20, défaut 8).

Exemple de requête

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

Exemple de réponse

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

Autocomplétion de lieux : régions, départements et communes.

Paramètres

ParamètreTypeRequisDescription
qstringOuiTexte saisi (≥ 2 caractères).
limitintNonNombre de suggestions (1–12, défaut 8).

Exemple de requête

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

Exemple de réponse

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

Dernières offres d'alternance publiées, avec filtre lieu optionnel.

Paramètres

ParamètreTypeRequisDescription
lieustringNonRégion / département / commune.
latfloatNonLatitude (recherche par rayon).
lngfloatNonLongitude (recherche par rayon).
radiusfloatNonRayon en km (défaut 30).
limitintNonNombre d'offres (1–100, défaut 20).

Exemple de requête

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

Exemple de réponse

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

Détail complet d'une offre : contrat, employeur, localisation, candidature.

Paramètres

ParamètreTypeRequisDescription
idpathOuiIdentifiant de l'offre (champ `id` renvoyé par la recherche).

Exemple de requête

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

Exemple de réponse

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

Détail complet d'une formation : diplôme, RNCP, organisme (CFA), rythme.

Paramètres

ParamètreTypeRequisDescription
idpathOuiIdentifiant de la formation (champ `id` renvoyé par la recherche).

Exemple de requête

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

Exemple de réponse

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

Profil employeur par SIRET et liste de ses offres d'alternance ouvertes.

Paramètres

ParamètreTypeRequisDescription
siretpathOuiSIRET à 14 chiffres.

Exemple de requête

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

Exemple de réponse

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

Statistiques agrégées de la plateforme (+ compteurs par métier).

Paramètres

ParamètreTypeRequisDescription
metierstringNonSi fourni, ajoute les compteurs propres à ce métier.

Exemple de requête

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

Exemple de réponse

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

Codes d'erreur

Les erreurs suivent une forme unique : { "error": { "code": "…", "message": "…" } }.

StatutCodeSignification
400bad_requestParamètre manquant ou invalide.
401unauthorizedToken d'accès manquant.
403forbiddenToken d'accès invalide.
404not_foundRessource introuvable.
500internalErreur serveur ou API non configurée.

Pour les agents IA

Le catalogue JSON public décrit tous les endpoints, paramètres et erreurs de façon lisible par une machine, sans authentification. Point d'entrée idéal pour un agent qui découvre l'API.

Ouvrir le catalogue JSON

Référence API v1 — Endpoints, paramètres et exemples | superalternance · superalternance