85.057 offerte · 62.076 corsi
Riferimento tecnico

Riferimento API v1

Autenticazione, endpoint, parametri, esempi curl e risposte JSON. Base: tutti gli URL sono relativi all'origine di produzione.

Autenticazione

Trasmetti il tuo token partner in una di queste intestazioni HTTP a ogni richiesta (escluso il catalogo pubblico):

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

Gli esempi di richieste (curl) e di risposte (JSON) sono forniti in modo identico in tutte le lingue — sono dati tecnici.

Endpoint

GET/api/v1Pubblico

Catalogo auto-documentato dell'API (pubblico, senza token).

Esempio di richiesta

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

Esempio di risposta

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

Autocompletamento « professione o corso di formazione » per una barra di ricerca.

Parametri

ParametroTipoRichiestoDescrizione
qstringTesto inserito (≥ 2 caratteri).
limitintNoNumero di suggerimenti (1–20, predefinito 8).

Esempio di richiesta

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

Esempio di risposta

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

Autocompletamento di luoghi: regioni, dipartimenti e comuni.

Parametri

ParametroTipoRichiestoDescrizione
qstringTesto inserito (≥ 2 caratteri).
limitintNoNumero di suggerimenti (1–12, predefinito 8).

Esempio di richiesta

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

Esempio di risposta

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

Ultime offerte di apprendistato pubblicate, con filtro luogo facoltativo.

Parametri

ParametroTipoRichiestoDescrizione
lieustringNoRegione / dipartimento / comune.
latfloatNoLatitudine (ricerca per raggio).
lngfloatNoLongitudine (ricerca per raggio).
radiusfloatNoRaggio in km (predefinito 30).
limitintNoNumero di offerte (1–100, predefinito 20).

Esempio di richiesta

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

Esempio di risposta

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

Dettaglio completo di un'offerta: contratto, datore di lavoro, localizzazione, candidatura.

Parametri

ParametroTipoRichiestoDescrizione
idpathIdentificatore dell'offerta (campo `id` restituito dalla ricerca).

Esempio di richiesta

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

Esempio di risposta

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

Dettaglio completo di un corso di formazione: titolo di studio, RNCP, organismo (CFA), ritmo.

Parametri

ParametroTipoRichiestoDescrizione
idpathIdentificatore del corso (campo `id` restituito dalla ricerca).

Esempio di richiesta

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

Esempio di risposta

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

Profilo del datore di lavoro per SIRET ed elenco delle sue offerte di apprendistato aperte.

Parametri

ParametroTipoRichiestoDescrizione
siretpathSIRET a 14 cifre.

Esempio di richiesta

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

Esempio di risposta

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

Statistiche aggregate della piattaforma (+ contatori per professione).

Parametri

ParametroTipoRichiestoDescrizione
metierstringNoSe fornito, aggiunge i contatori specifici di questa professione.

Esempio di richiesta

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

Esempio di risposta

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

Codici di errore

Gli errori seguono una forma unica: { "error": { "code": "…", "message": "…" } }.

StatoCodiceSignificato
400bad_requestParametro mancante o non valido.
401unauthorizedToken di accesso mancante.
403forbiddenToken di accesso non valido.
404not_foundRisorsa non trovata.
500internalErrore del server o API non configurata.

Per gli agenti IA

Il catalogo JSON pubblico descrive tutti gli endpoint, i parametri e gli errori in modo leggibile da una macchina, senza autenticazione. Punto di ingresso ideale per un agente che esplora l'API.

Apri il catalogo JSON

Riferimento API v1 — Endpoint, parametri ed esempi | superalternance · superalternance