System
Endpoints systeme pour le monitoring et les informations de configuration.
GET /health
Health check basique. Aucune authentification requise.
Reponse 200
json
{
"status": "ok"
}Exemple curl
bash
curl "https://api.opcovia.com/health"GET /:opcoId/status
Statut de l'API OPCO sous-jacente.
Auth : X-API-KEY obligatoire.
Parametres de chemin
| Parametre | Type | Description |
|---|---|---|
opcoId | string | Identifiant de l'OPCO (ex: opco-ep) |
Reponse 200
json
{
"status": "healthy",
"supportedVersions": ["1.0", "1.1"],
"uptime": 86400
}| Champ | Type | Description |
|---|---|---|
status | enum | healthy, degraded ou unhealthy |
supportedVersions | array | Versions de l'API supportees |
uptime | number | Uptime en secondes |
Exemple curl
bash
curl -H "X-API-KEY: votre-cle" \
"https://api.opcovia.com/opco-ep/status"GET /:opcoId/cfakeyinfo
Informations de validite de la cle API CFA aupres de l'OPCO.
Auth : X-API-KEY obligatoire.
Parametres de requete
| Parametre | Type | Requis | Description |
|---|---|---|---|
siren | string | Oui | SIREN du CFA (min 9 caracteres) |
XAPIKEY | string | Oui | API-KEY attribuee au SIREN |
Reponse 200
json
{
"status": "success",
"dateFinValidite": "2025-12-31",
"comment": null
}| Champ | Type | Description |
|---|---|---|
status | enum | success ou error |
dateFinValidite | string | Date de fin de validite de la cle (YYYY-MM-DD) |
comment | string | Commentaire eventuel |
Erreurs
| Code HTTP | Code erreur | Description |
|---|---|---|
| 400 | VALIDATION_ERROR | siren ou XAPIKEY manquant ou invalide |
| 403 | HTTP_ERROR | X-API-KEY manquant |
| 501 | NOT_SUPPORTED | Endpoint non supporte par cet OPCO |
Exemple curl
bash
curl -H "X-API-KEY: votre-cle" \
"https://api.opcovia.com/opco-ep/cfakeyinfo?siren=123456789&XAPIKEY=cle-cfa"GET /doc
Documentation OpenAPI (JSON) generee automatiquement. Aucune authentification requise.
Reponse 200
Retourne le document OpenAPI 3.0 au format JSON.
Exemple curl
bash
curl "https://api.opcovia.com/doc"