Referentie API v1

Zelfdocumenterende catalogus van de API (openbaar, zonder token).

Voorbeeldaanvraag

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

Voorbeeldantwoord

{
  "name": "superalternance API partenaires",
  "version": "1",
  "authentication": { "type": "bearer", "description": "…" },
  "endpoints": [ … ]
}

Autocomplete « beroep of opleiding » voor een zoekbalk.

Parameters

Voorbeeldaanvraag

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

Voorbeeldantwoord

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

Autocomplete van locaties: regio's, departementen en gemeenten.

Parameters

Voorbeeldaanvraag

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

Voorbeeldantwoord

{
  "query": "lyon",
  "suggestions": [
    { "kind": "city", "value": "Lyon", "secondary": "69001 · Rhône", "lat": 45.758, "lng": 4.835 }
  ]
}

Gecombineerd zoeken naar vacatures + opleidingen, filterbaar op locatie, beroep, opleiding en niveau.

Parameters

Voorbeeldaanvraag

curl -H "Authorization: Bearer $TOKEN" \
  "https://www.superalternance.com/api/v1/search?metier=boulanger&lieu=Lyon&type=jobs&limit=5"

Voorbeeldantwoord

{
  "filters": { "metier": "boulanger", "resolvedRomeCodes": ["D1102", "D1104"], "lieu": "Lyon", "type": "jobs" },
  "pagination": { "limit": 5, "offset": 0 },
  "totals": { "jobs": 42, "formations": 0 },
  "results": [
    {
      "kind": "job", "id": "…", "title": "Boulanger en alternance",
      "subtitle": "Maison Dupain · Lyon", "city": "Lyon",
      "latitude": 45.75, "longitude": 4.84,
      "labels": ["Apprentissage", "CAP"],
      "url": "https://www.superalternance.com/fr/offres/…"
    }
  ]
}

Recentste gepubliceerde vacatures voor leerwerktrajecten, met optioneel locatiefilter.

Parameters

Voorbeeldaanvraag

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

Voorbeeldantwoord

{
  "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/…" }
  ]
}

Volledige details van een vacature: contract, werkgever, locatie, sollicitatie.

Parameters

Voorbeeldaanvraag

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

Voorbeeldantwoord

{
  "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": "…" }
  }
}

Volledige details van een opleiding: diploma, RNCP, instelling (CFA), ritme.

Parameters

Voorbeeldaanvraag

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

Voorbeeldantwoord

{
  "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": "…" }
  }
}

Werkgeversprofiel op SIRET en lijst van openstaande vacatures voor leerwerktrajecten.

Parameters

Voorbeeldaanvraag

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

Voorbeeldantwoord

{
  "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": [ … ]
  }
}

Geaggregeerde statistieken van het platform (+ tellers per beroep).

Parameters

Voorbeeldaanvraag

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

Voorbeeldantwoord

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