Espace développeurs

CareFlow API

L'API REST de CareFlow expose la planification, le dispatch et la mesure de l'assistance PMR. Elle est décrite par une spécification OpenAPI 3 et consommée par l'application elle-même ; les intégrateurs autorisés y accèdent avec le même jeton que les utilisateurs.

Spécification OpenAPI

GET /openapi.json (aussi servie à /api/openapi.json). Chaque opération porte un operationId unique, une description, des paramètres typés et un schéma de réponse.

Base URL

https://careflow.opsis-aero.com/api. Toujours viser ce domaine canonique : les alias *.vercel.app redirigent (308) et une redirection fait perdre l'en-tête Authorization.

Authentification

Les appels se font avec un jeton JWT émis à la connexion (courriel professionnel OPSIS et mot de passe) par le fournisseur d'identité de la plateforme ; l'API le vérifie par JWKS et en déduit le rôle de l'utilisateur (agent, superviseur, coordonnateur, planificateur, administrateur) à partir du référentiel central des accès. Il n'existe pas de clés d'API anonymes ni d'inscription libre : un compte est créé par un gestionnaire OPSIS. Pour une intégration de système à système, écrivez-nous (objet « API »).

curl -sS https://careflow.opsis-aero.com/api/me \
  -H "Authorization: Bearer <jeton>" \
  -H "Accept: application/json"

Endpoints publics (sans jeton)

Méthode et chemin	Usage
`GET /api/health`	État du service, nom de l'application, environnement, horodatage UTC.
`GET /openapi.json`	Spécification OpenAPI 3 complète.
`GET /llms.txt`	Présentation de CareFlow pour les agents et assistants IA, avec les cas d'usage.

curl -sS https://careflow.opsis-aero.com/api/health
{"status":"ok","app":"careflow-api","environment":"production","timestamp":"2026-11-01T15:05:18Z"}

Familles d'endpoints (jeton requis)

Le rôle exigé varie selon l'opération : certaines acceptent tout compte authentifié, d'autres un planificateur, un superviseur ou un administrateur. Une réponse 403 signale un rôle insuffisant.

Préfixe	Domaine
`/api/me`	Identité et rôle de l'appelant.
`/api/scenarios`, `/api/planning`, `/api/forecast`, `/api/replanning`	Prévision de la demande, versions de planning, quarts générés, sauvegarde auditable.
`/api/planning/rules`	Règles métier éditables (constantes de charge, seuils) et leur journal.
`/api/coordinator`, `/api/confirmations`, `/api/derogations`	Quarts et vols du jour, rentabilité, confirmations de quart, dérogations.
`/api/agents`, `/api/flights`	Agents planifiés, recherche de vols à critères partiels.
`/api/charge`, `/api/qualite-service`, `/api/analyse`, `/api/anomalies`, `/api/reconciliation`, `/api/assistance-control`	Mesure : charge, attentes, biais de prévision, anomalies de saisie, réconciliation planning/réel.
`/api/admin`, `/api/settings`, `/api/studio`	Administration, destinataires des courriels, studio de revue des plannings.

Conventions

JSON en entrée et en sortie (application/json) ; dates civiles au format YYYY-MM-DD, instants en ISO 8601 UTC ; fuseau d'affichage America/Toronto.
Erreurs : 401 jeton absent ou invalide, 403 rôle insuffisant, 404 ressource inconnue, 422 corps ou paramètre invalide (détail dans detail).
Les chemins inconnus hors /api répondent 404 avec un corps Markdown si l'en-tête Accept: text/markdown est présent.
Pas de limite de débit publiée.

Pour les agents IA

Le fichier /llms.txt décrit quand faire appel à CareFlow et comment. La page d'accueil et les pages publiques sont aussi servies en Markdown avec Accept: text/markdown. Il n'existe pas encore de serveur MCP, de SDK ni d'outil en ligne de commande officiels : l'intégration passe par l'API REST décrite ici.

Code source

CareFlow est développé par OPSIS dans l'organisation GitHub OPSIS-SA (dépôts privés ; accès sur demande aux partenaires).