Généralités
-- Introduction à l'API CAIH
L'API CAIH est une API REST JSON.
Dans l'environnement de test l'authentification se fait par la transmission d'un login et d'un mot de passe en base64 dans le header.
Dans l'environnement de test l'authentification se fait par la transmission d'un login et d'un mot de passe en base64 dans le header.
Base64
PHP : base64_encode($username . ":" . $password)
Java : Base64.getEncoder().encodeToString(username + ":" + password);
En production, la méthode d'authentification ainsi que la méthode de cryptage vous seront transmises avec la configuration de votre compte.
Une bibliothèque POSTMAN est mise à disposition des éditeurs CAIH et est téléchargeable via le lien suivant : Collection API CAIH (Après téléchargement, veuillez importer le fichier dans POSTMAN)
| Fonctionalités | Endpoints API | Précisions |
|---|---|---|
| Récupération des références des établissements et des régies |
liste_beneficiaires
liste_regies |
Ces références sont uniques par établissement de santé. Elles permettent l’étanchéité entre ces derniers et le reversement des fonds sur le compte associé de la régie.
|
| Création de mandat (Prélèvement) | recherche_patient | L’appel à cette méthode API est obligatoire avant la création d’un mandat et avant l’initiation d’un virement. |
| Création d'un paiement |
paiement (prélèvement)
initier_sct (virement) |
La cinématique de virement doit toujours commencer par la requête "recherche_patient" avant l’initiation du virement afin de savoir si le patient existe déjà. |
| Suivi et gestion des paiements |
recherche_paiement (virement et prélèvement)
modifier_sdd (prélèvement) |
La modification d'un paiement est sujet à des règles de gestion métiers, fonctionnelles et réglementaires . |
| Suivi et Gestion de la Mandathèque |
recherche_mandat
revoquer_mandat modifier_info_patient modifier_lot_mandat |
La modification et la révocation d'un mandat sont sujets à des règles de gestion métiers, fonctionnelles et réglementaires. |
| Annulation d'un Paiement |
annuler_paiement (annule la transaction et toutes les échéances associées pour virement et prélèvement)
annuler_lot_sdd (prélèvement) |
L'annulation d'un paiement est sujet à des règles de gestion métiers, fonctionnelles et réglementaires. |
| Journal des Opérations | journal_operations | Cette API permet à l'éditeur de récupérer un certain nombre d'informations liées aux transactions/échéances. |