Démarrer en mode test

En dix minutes, vous créez une facture de test et vous la menez jusqu’au paiement. Le mode test passe par un simulateur : il ne touche ni l’Assurance Maladie ni une vraie carte, et toutes ses données sont fictives.

Il vous faut un terminal et curl. Les exemples existent aussi en PHP et en TypeScript.

Créer une clé

Créez un compte sur app.ophelix.fr , confirmez votre adresse et activez le second facteur. Ouvrez ensuite Développeurs › Clés et créez une clé secrète. Elle commence par sk_test_ et ne s’affiche qu’une fois : gardez-la.

Rangez-la dans votre shell. Dans tous les exemples, remplacez sk_test_… par votre clé.

Envoyer une première requête

curl


curl https://api.ophelix.fr/v1/practitioners \
  -H "Authorization: Bearer sk_test_…"

PHP


function ophelix(string $method, string $path, ?array $body = null): array
{
    $client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
    $options = ['headers' => ['Authorization' => 'Bearer sk_test_…']];
 
    if ($body !== null) {
        $options['json'] = $body;
    }
 
    return json_decode((string) $client->request($method, "/v1{$path}", $options)->getBody(), true);
}
 
$practitioners = ophelix('GET', '/practitioners');

TypeScript


async function ophelix(method: string, path: string, body?: unknown) {
  const response = await fetch(`https://api.ophelix.fr/v1${path}`, {
    method,
    headers: { Authorization: 'Bearer sk_test_…', 'Content-Type': 'application/json' },
    body: body === undefined ? undefined : JSON.stringify(body),
  })
 
  return response.json()
}
 
const practitioners = await ophelix('GET', '/practitioners')

La réponse est une liste, vide pour l’instant. Toute réponse porte un en-tête Request-Id : retrouvez l’appel dans Développeurs › Requêtes.

Créer un praticien

Un praticien naît de la lecture de sa carte CPS. En mode test, une carte est un scénario : cps_doctor est un médecin généraliste qui peut facturer.

curl


curl https://api.ophelix.fr/v1/practitioners \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{"card": "cps_doctor"}'

PHP


$practitioner = ophelix('POST', '/practitioners', ['card' => 'cps_doctor']);

TypeScript


const practitioner = await ophelix('POST', '/practitioners', { card: 'cps_doctor' })

Gardez son id, qui commence par prac_. Le statut ready dit qu’il peut facturer.

Lire les droits d’un patient

La lecture d’une carte Vitale crée le patient et ses droits d’un coup.

curl


curl https://api.ophelix.fr/v1/coverages \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{"source": "vitale_card", "card": "vitale_ok"}'

PHP


$coverage = ophelix('POST', '/coverages', ['source' => 'vitale_card', 'card' => 'vitale_ok']);

TypeScript


const coverage = await ophelix('POST', '/coverages', { source: 'vitale_card', card: 'vitale_ok' })

Le champ patient de la réponse donne l’identifiant du patient, qui commence par pat_.

Ouvrir la facture

Une facture naît en brouillon. Sans autre précision, elle prend la dernière lecture de droits du patient et la première situation facturable du praticien. Un médecin dit sous context sa situation au regard du parcours de soins et si les soins suivent un accident : voir Factures. Tous les montants sont en centimes.

curl


curl https://api.ophelix.fr/v1/claims \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{
    "practitioner": "prac_…",
    "patient": "pat_…",
    "third_party_amo": true,
    "context": {"care_pathway": "treating_doctor", "common_law_accident": false},
    "lines": [{"nomenclature": "ngap", "code": "ZC", "service_date": "2026-11-06", "unit_price_cents": 2650}]
  }'

PHP


$claim = ophelix('POST', '/claims', [
    'practitioner' => $practitioner['id'],
    'patient' => $coverage['patient'],
    'third_party_amo' => true,
    'context' => ['care_pathway' => 'treating_doctor', 'common_law_accident' => false],
    'lines' => [['nomenclature' => 'ngap', 'code' => 'ZC', 'service_date' => '2026-11-06', 'unit_price_cents' => 2650]],
]);

TypeScript


const claim = await ophelix('POST', '/claims', {
  practitioner: practitioner.id,
  patient: coverage.patient,
  third_party_amo: true,
  context: { care_pathway: 'treating_doctor', common_law_accident: false },
  lines: [{ nomenclature: 'ngap', code: 'ZC', service_date: '2026-11-06', unit_price_cents: 2650 }],
})

Gardez son id, qui commence par clm_. La réponse porte déjà les parts :


{
  "id": "clm_…",
  "object": "claim",
  "status": "draft",
  "amount_cents": 2650,
  "amo_amount_cents": 1855,
  "amc_amount_cents": 0,
  "patient_amount_cents": 795
}

En mode test, les parts viennent d’un taux fictif : ne vous en servez pas comme référence.

Valider, puis signer

validate contrôle la facture sans rien changer, finalize la passe à prête, secure la signe.

curl


curl -X POST https://api.ophelix.fr/v1/claims/clm_…/validate -H "Authorization: Bearer sk_test_…"
curl -X POST https://api.ophelix.fr/v1/claims/clm_…/finalize -H "Authorization: Bearer sk_test_…"
curl -X POST https://api.ophelix.fr/v1/claims/clm_…/secure -H "Authorization: Bearer sk_test_…"

PHP


$validation = ophelix('POST', "/claims/{$claim['id']}/validate");
ophelix('POST', "/claims/{$claim['id']}/finalize");
ophelix('POST', "/claims/{$claim['id']}/secure");

TypeScript


const validation = await ophelix('POST', `/claims/${claim.id}/validate`)
await ophelix('POST', `/claims/${claim.id}/finalize`)
await ophelix('POST', `/claims/${claim.id}/secure`)

validate répond "valid": true et une liste violations vide. La facture est maintenant secured.

Simuler les retours

En production, l’accusé de réception et le paiement arrivent de l’Assurance Maladie. En mode test, vous les déclenchez.

curl


curl https://api.ophelix.fr/v1/test-helpers/claims/clm_…/returns \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{"scenario": "arl_positive"}'
curl https://api.ophelix.fr/v1/test-helpers/claims/clm_…/returns \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{"scenario": "payment"}'

PHP


ophelix('POST', "/test-helpers/claims/{$claim['id']}/returns", ['scenario' => 'arl_positive']);
$paid = ophelix('POST', "/test-helpers/claims/{$claim['id']}/returns", ['scenario' => 'payment']);

TypeScript


await ophelix('POST', `/test-helpers/claims/${claim.id}/returns`, { scenario: 'arl_positive' })
const paid = await ophelix('POST', `/test-helpers/claims/${claim.id}/returns`, { scenario: 'payment' })

La facture est paid, et paid_amount_cents vaut ce que les organismes doivent : 1855 ici.

Relire sa chronologie

Chaque état traversé a produit un événement.

curl


curl "https://api.ophelix.fr/v1/events?object=clm_…" \
  -H "Authorization: Bearer sk_test_…"

PHP


$events = ophelix('GET', "/events?object={$claim['id']}");

TypeScript


const events = await ophelix('GET', `/events?object=${claim.id}`)

De claim.created à claim.paid, du plus récent au plus ancien. C’est fini : votre première facture de test est payée.

Aller plus vite

POST /v1/test-helpers/claims lit deux cartes et ouvre un brouillon en un seul appel. Le bouton Créer une feuille de soins de test, dans Feuilles de soins, fait la même chose.


curl -X POST https://api.ophelix.fr/v1/test-helpers/claims \
  -H "Authorization: Bearer sk_test_…"

La suite

Recevoir ces événements sur votre serveur, plutôt que de les relire.
Provoquer une erreur : droits fermés, carte illisible, facture rejetée.
Tout savoir sur les factures : états, prestations, validation.
Rejouer une écriture sans risque, avant de passer en production.