Simuler la lecture d’une carte

POST/v1/test-helpers/card-reads

Mode test seulement

Corps de la requête

card_typeénumérationobligatoire
Le genre de carte.
vitalecps
scenariotexteobligatoire
Un scénario de /v1/test-helpers/scenarios.

En-têtes

Idempotency-Keytexte
Rend le rejeu de cette écriture sûr pendant 24 heures. Idempotence.

Réponse

Rend le corps ci-contre.

Une erreur suit le format commun.

Requête

curl


curl -X POST https://api.ophelix.fr/v1/test-helpers/card-reads \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{"card_type":"vitale","scenario":"vitale_ok"}'

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->post('/v1/test-helpers/card-reads', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
    'json' => [
        'card_type' => 'vitale',
        'scenario' => 'vitale_ok',
    ],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/test-helpers/card-reads', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    card_type: 'vitale',
    scenario: 'vitale_ok'
  }),
})
const object = await response.json()

Réponse 200


{
  "object": "simulated_card_read",
  "card_type": "vitale",
  "engine": "simulator",
  "card": {
    "label": "Assuré aux droits ouverts",
    "nir": "900000000000197",
    "first_name": "Camille",
    "last_name": "Exemple",
    "birth_date": "1985-05-12",
    "rank": 1,
    "quality": "insured",
    "rights": "open",
    "regime_code": "01",
    "fund_code": "751",
    "center_code": "0001",
    "exemptions": [],
    "valid_until": "2030-12-31",
    "scenario": "vitale_ok"
  }
}