Autenticación, endpoints, parámetros, ejemplos curl y respuestas JSON. Base: todas las URL son relativas al origen de producción.
Transmite tu token de socio en una de estas cabeceras HTTP en cada solicitud (excepto el catálogo público):
Authorization: Bearer <token>
# ou
X-Api-Key: <token>Los ejemplos de solicitudes (curl) y de respuestas (JSON) se proporcionan de forma idéntica en todos los idiomas — son datos técnicos.
/api/v1PúblicoCatálogo autodocumentado de la API (público, sin token).
curl "https://www.superalternance.com/api/v1"{
"name": "superalternance API partenaires",
"version": "1",
"authentication": { "type": "bearer", "description": "…" },
"endpoints": [ … ]
}/api/v1/suggestToken requeridoAutocompletado «oficio o formación» para una barra de búsqueda.
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
q | string | Sí | Texto introducido (≥ 2 caracteres). |
limit | int | No | Número de sugerencias (1–20, por defecto 8). |
curl -H "Authorization: Bearer $TOKEN" \
"https://www.superalternance.com/api/v1/suggest?q=boul&limit=5"{
"query": "boul",
"suggestions": [
{ "kind": "rome", "value": "Boulanger", "secondary": "Métier" },
{ "kind": "formation", "value": "CAP Boulanger", "secondary": "CFA des métiers" }
]
}/api/v1/placesToken requeridoAutocompletado de lugares: regiones, departamentos y municipios.
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
q | string | Sí | Texto introducido (≥ 2 caracteres). |
limit | int | No | Número de sugerencias (1–12, por defecto 8). |
curl -H "Authorization: Bearer $TOKEN" \
"https://www.superalternance.com/api/v1/places?q=lyon"{
"query": "lyon",
"suggestions": [
{ "kind": "city", "value": "Lyon", "secondary": "69001 · Rhône", "lat": 45.758, "lng": 4.835 }
]
}/api/v1/searchToken requeridoBúsqueda unificada ofertas + formaciones, filtrable por lugar, oficio, formación y nivel.
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
q | string | No | Texto libre (título de formación, palabras clave). |
metier | string | No | Nombre de profesión — resuelto en códigos ROME (como LBA). |
lieu | string | No | Región / departamento / municipio. |
lat | float | No | Latitud (búsqueda por radio). |
lng | float | No | Longitud (búsqueda por radio). |
radius | float | No | Radio en km (por defecto 30). |
type | enum | No | jobs | formations | all (por defecto all). |
niveau | csv | No | Niveles de diploma entre 3,4,5,6,7 (3=CAP … 7=Bac+5). |
sort | enum | No | relevance | date | diploma (por defecto relevance). |
limit | int | No | Tamaño de página (1–100, por defecto 20). |
offset | int | No | Desplazamiento de paginación (por defecto 0). |
curl -H "Authorization: Bearer $TOKEN" \
"https://www.superalternance.com/api/v1/search?metier=boulanger&lieu=Lyon&type=jobs&limit=5"{
"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/…"
}
]
}/api/v1/jobs/latestToken requeridoÚltimas ofertas de alternancia publicadas, con filtro de lugar opcional.
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
lieu | string | No | Región / departamento / municipio. |
lat | float | No | Latitud (búsqueda por radio). |
lng | float | No | Longitud (búsqueda por radio). |
radius | float | No | Radio en km (por defecto 30). |
limit | int | No | Número de ofertas (1–100, por defecto 20). |
curl -H "Authorization: Bearer $TOKEN" \
"https://www.superalternance.com/api/v1/jobs/latest?lieu=Bordeaux&limit=10"{
"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/…" }
]
}/api/v1/jobs/{id}Token requeridoDetalle completo de una oferta: contrato, empleador, ubicación, candidatura.
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
id | path | Sí | Identificador de la oferta (campo `id` devuelto por la búsqueda). |
curl -H "Authorization: Bearer $TOKEN" \
"https://www.superalternance.com/api/v1/jobs/abc123"{
"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": "…" }
}
}/api/v1/formations/{id}Token requeridoDetalle completo de una formación: titulación, RNCP, organismo (CFA), ritmo.
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
id | path | Sí | Identificador de la formación (campo `id` devuelto por la búsqueda). |
curl -H "Authorization: Bearer $TOKEN" \
"https://www.superalternance.com/api/v1/formations/xyz789"{
"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": "…" }
}
}/api/v1/companies/{siret}Token requeridoPerfil del empleador por SIRET y lista de sus ofertas de alternancia abiertas.
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
siret | path | Sí | SIRET de 14 dígitos. |
curl -H "Authorization: Bearer $TOKEN" \
"https://www.superalternance.com/api/v1/companies/12345678901234"{
"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": [ … ]
}
}/api/v1/statsToken requeridoEstadísticas agregadas de la plataforma (+ contadores por oficio).
| Parámetro | Tipo | Requerido | Descripción |
|---|---|---|---|
metier | string | No | Si se proporciona, añade los contadores propios de esa profesión. |
curl -H "Authorization: Bearer $TOKEN" \
"https://www.superalternance.com/api/v1/stats?metier=boulanger"{
"jobs": 17658, "formations": 58596, "cfa": 6923,
"lastSyncAt": "2026-06-04T21:01:06.369Z",
"metier": { "name": "boulanger", "jobs": 42, "formations": 120, "diplomas": 8 }
}Los errores siguen una forma única: { "error": { "code": "…", "message": "…" } }.
| Estado | Código | Significado |
|---|---|---|
400 | bad_request | Parámetro ausente o inválido. |
401 | unauthorized | Token de acceso ausente. |
403 | forbidden | Token de acceso inválido. |
404 | not_found | Recurso no encontrado. |
500 | internal | Error del servidor o API no configurada. |
El catálogo JSON público describe todos los endpoints, parámetros y errores de forma legible por una máquina, sin autenticación. Punto de entrada ideal para un agente que descubre la API.