85 057 предложений · 62 076 программ
Техническая справка

Справочник API v1

Аутентификация, эндпоинты, параметры, примеры curl и ответы JSON. База: все URL указаны относительно продакшн-источника.

Аутентификация

Передавайте свой партнёрский токен в одном из этих HTTP-заголовков в каждом запросе (кроме публичного каталога):

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

Примеры запросов (curl) и ответов (JSON) приводятся одинаково на всех языках — это технические данные.

Эндпоинты

GET/api/v1Публичный

Самодокументируемый каталог API (публичный, без токена).

Пример запроса

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

Пример ответа

{
  "name": "superalternance API partenaires",
  "version": "1",
  "authentication": { "type": "bearer", "description": "…" },
  "endpoints": [ … ]
}
GET/api/v1/suggestТребуется токен

Автодополнение «профессия или программа обучения» для строки поиска.

Параметры

ПараметрТипОбязательныйОписание
qstringДаВведённый текст (≥ 2 символов).
limitintНетКоличество подсказок (1–20, по умолчанию 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" }
  ]
}
GET/api/v1/placesТребуется токен

Автодополнение мест: регионы, департаменты и коммуны.

Параметры

ПараметрТипОбязательныйОписание
qstringДаВведённый текст (≥ 2 символов).
limitintНетКоличество подсказок (1–12, по умолчанию 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 }
  ]
}
GET/api/v1/jobs/latestТребуется токен

Последние опубликованные вакансии alternance с необязательным фильтром по месту.

Параметры

ПараметрТипОбязательныйОписание
lieustringНетРегион / департамент / населённый пункт.
latfloatНетШирота (поиск по радиусу).
lngfloatНетДолгота (поиск по радиусу).
radiusfloatНетРадиус в км (по умолчанию 30).
limitintНетКоличество вакансий (1–100, по умолчанию 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/…" }
  ]
}
GET/api/v1/jobs/{id}Требуется токен

Полные сведения о вакансии: контракт, работодатель, местоположение, подача заявки.

Параметры

ПараметрТипОбязательныйОписание
idpathДаИдентификатор вакансии (поле `id`, возвращаемое поиском).

Пример запроса

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": "…" }
  }
}
GET/api/v1/formations/{id}Требуется токен

Полные сведения о программе обучения: диплом, RNCP, организация (CFA), режим обучения.

Параметры

ПараметрТипОбязательныйОписание
idpathДаИдентификатор обучения (поле `id`, возвращаемое поиском).

Пример запроса

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": "…" }
  }
}
GET/api/v1/companies/{siret}Требуется токен

Профиль работодателя по SIRET и список его открытых вакансий alternance.

Параметры

ПараметрТипОбязательныйОписание
siretpathДаSIRET из 14 цифр.

Пример запроса

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": [ … ]
  }
}
GET/api/v1/statsТребуется токен

Агрегированная статистика платформы (+ счётчики по профессиям).

Параметры

ПараметрТипОбязательныйОписание
metierstringНетЕсли указано, добавляет счётчики, относящиеся к этой профессии.

Пример запроса

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 }
}

Коды ошибок

Ошибки имеют единую форму: { "error": { "code": "…", "message": "…" } }.

СтатусКодЗначение
400bad_requestОтсутствует или недопустимый параметр.
401unauthorizedОтсутствует токен доступа.
403forbiddenНедопустимый токен доступа.
404not_foundРесурс не найден.
500internalОшибка сервера или API не настроен.

Для ИИ-агентов

Публичный каталог JSON описывает все эндпоинты, параметры и ошибки в машиночитаемом виде, без аутентификации. Идеальная точка входа для агента, который знакомится с API.

Открыть каталог JSON

Справочник API v1 — эндпоинты, параметры и примеры | superalternance · superalternance