Autenticação, endpoints, parâmetros, exemplos curl e respostas JSON. Base: todos os URL são relativos à origem de produção.
Transmita o seu token de parceiro num destes cabeçalhos HTTP em cada pedido (exceto no catálogo público):
Authorization: Bearer <token>
# ou
X-Api-Key: <token>Os exemplos de pedidos (curl) e de respostas (JSON) são fornecidos de forma idêntica em todas as línguas — são dados técnicos.
/api/v1PúblicoCatálogo autodocumentado da API (público, sem token).
curl "https://www.superalternance.com/api/v1"{
"name": "superalternance API partenaires",
"version": "1",
"authentication": { "type": "bearer", "description": "…" },
"endpoints": [ … ]
}/api/v1/suggestToken obrigatórioPreenchimento automático «profissão ou formação» para uma barra de pesquisa.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
q | string | Sim | Texto introduzido (≥ 2 caracteres). |
limit | int | Não | Número de sugestões (1–20, predefinição 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 obrigatórioPreenchimento automático de locais: regiões, departamentos e municípios.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
q | string | Sim | Texto introduzido (≥ 2 caracteres). |
limit | int | Não | Número de sugestões (1–12, predefinição 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 obrigatórioPesquisa unificada de ofertas + formações, filtrável por local, profissão, formação e nível.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
q | string | Não | Texto livre (título de formação, palavras-chave). |
metier | string | Não | Nome de profissão — resolvido em códigos ROME (como LBA). |
lieu | string | Não | Região / distrito / concelho. |
lat | float | Não | Latitude (pesquisa por raio). |
lng | float | Não | Longitude (pesquisa por raio). |
radius | float | Não | Raio em km (predefinição 30). |
type | enum | Não | jobs | formations | all (predefinição all). |
niveau | csv | Não | Níveis de diploma entre 3,4,5,6,7 (3=CAP … 7=Bac+5). |
sort | enum | Não | relevance | date | diploma (predefinição relevance). |
limit | int | Não | Tamanho da página (1–100, predefinição 20). |
offset | int | Não | Deslocamento de paginação (predefinição 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 obrigatórioÚltimas ofertas de alternância publicadas, com filtro de local opcional.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
lieu | string | Não | Região / distrito / concelho. |
lat | float | Não | Latitude (pesquisa por raio). |
lng | float | Não | Longitude (pesquisa por raio). |
radius | float | Não | Raio em km (predefinição 30). |
limit | int | Não | Número de ofertas (1–100, predefinição 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 obrigatórioDetalhe completo de uma oferta: contrato, empregador, localização, candidatura.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | path | Sim | Identificador da oferta (campo `id` devolvido pela pesquisa). |
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 obrigatórioDetalhe completo de uma formação: diploma, RNCP, organismo (CFA), ritmo.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | path | Sim | Identificador da formação (campo `id` devolvido pela pesquisa). |
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 obrigatórioPerfil do empregador por SIRET e lista das suas ofertas de alternância abertas.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
siret | path | Sim | SIRET com 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 obrigatórioEstatísticas agregadas da plataforma (+ contadores por profissão).
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
metier | string | Não | Se fornecido, adiciona os contadores próprios desta profissão. |
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 }
}Os erros seguem uma forma única: { "error": { "code": "…", "message": "…" } }.
| Estado | Código | Significado |
|---|---|---|
400 | bad_request | Parâmetro em falta ou inválido. |
401 | unauthorized | Token de acesso em falta. |
403 | forbidden | Token de acesso inválido. |
404 | not_found | Recurso não encontrado. |
500 | internal | Erro do servidor ou API não configurada. |
O catálogo JSON público descreve todos os endpoints, parâmetros e erros de forma legível por uma máquina, sem autenticação. Ponto de entrada ideal para um agente que descobre a API.