85 057 ofert · 62 076 szkoleń
Dokumentacja techniczna

Dokumentacja API v1

Uwierzytelnianie, endpointy, parametry, przykłady curl i odpowiedzi JSON. Baza: wszystkie adresy URL są względne wobec produkcyjnego źródła.

Uwierzytelnianie

Przekazuj swój token partnerski w jednym z tych nagłówków HTTP przy każdym żądaniu (poza katalogiem publicznym):

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

Przykłady zapytań (curl) i odpowiedzi (JSON) są podawane identycznie we wszystkich językach — są to dane techniczne.

Endpointy

GET/api/v1Publiczny

Samodokumentujący się katalog API (publiczny, bez tokenu).

Przykład żądania

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

Przykład odpowiedzi

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

Autouzupełnianie „zawód lub szkolenie” dla paska wyszukiwania.

Parametry

ParametrTypWymaganyOpis
qstringTakWprowadzony tekst (≥ 2 znaki).
limitintNieLiczba podpowiedzi (1–20, domyślnie 8).

Przykład żądania

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

Przykład odpowiedzi

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

Autouzupełnianie lokalizacji: regiony, departamenty i gminy.

Parametry

ParametrTypWymaganyOpis
qstringTakWprowadzony tekst (≥ 2 znaki).
limitintNieLiczba podpowiedzi (1–12, domyślnie 8).

Przykład żądania

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

Przykład odpowiedzi

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

Najnowsze opublikowane oferty nauki zawodu, z opcjonalnym filtrem lokalizacji.

Parametry

ParametrTypWymaganyOpis
lieustringNieRegion / departament / gmina.
latfloatNieSzerokość geograficzna (wyszukiwanie według promienia).
lngfloatNieDługość geograficzna (wyszukiwanie według promienia).
radiusfloatNiePromień w km (domyślnie 30).
limitintNieLiczba ofert (1–100, domyślnie 20).

Przykład żądania

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

Przykład odpowiedzi

{
  "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}Wymagany token

Pełne szczegóły oferty: umowa, pracodawca, lokalizacja, aplikowanie.

Parametry

ParametrTypWymaganyOpis
idpathTakIdentyfikator oferty (pole `id` zwracane przez wyszukiwanie).

Przykład żądania

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

Przykład odpowiedzi

{
  "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}Wymagany token

Pełne szczegóły szkolenia: dyplom, RNCP, placówka (CFA), tryb nauki.

Parametry

ParametrTypWymaganyOpis
idpathTakIdentyfikator szkolenia (pole `id` zwracane przez wyszukiwanie).

Przykład żądania

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

Przykład odpowiedzi

{
  "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}Wymagany token

Profil pracodawcy według SIRET i lista jego otwartych ofert nauki zawodu.

Parametry

ParametrTypWymaganyOpis
siretpathTak14-cyfrowy SIRET.

Przykład żądania

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

Przykład odpowiedzi

{
  "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/statsWymagany token

Zagregowane statystyki platformy (+ liczniki według zawodu).

Parametry

ParametrTypWymaganyOpis
metierstringNieJeśli podano, dodaje liczniki właściwe dla tego zawodu.

Przykład żądania

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

Przykład odpowiedzi

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

Kody błędów

Błędy mają jednolitą postać: { "error": { "code": "…", "message": "…" } }.

StatusKodZnaczenie
400bad_requestBrakujący lub nieprawidłowy parametr.
401unauthorizedBrak tokenu dostępu.
403forbiddenNieprawidłowy token dostępu.
404not_foundNie znaleziono zasobu.
500internalBłąd serwera lub nieskonfigurowane API.

Dla agentów AI

Publiczny katalog JSON opisuje wszystkie endpointy, parametry i błędy w sposób czytelny dla maszyny, bez uwierzytelniania. Idealny punkt wejścia dla agenta poznającego API.

Otwórz katalog JSON

Dokumentacja API v1 — Endpointy, parametry i przykłady | superalternance · superalternance