Demander une lecture ou une signature à un poste

POST/v1/workstation-actions

L’agent du poste relève la demande en deux secondes au plus tant qu’une page est associée, sinon à son prochain appel d’état. Elle expire au bout de deux minutes si personne ne la prend. Suivez-la par workstation_action.succeeded et workstation_action.failed, ou en la relisant.

Droit de clé restreinte : workstations:write.

Corps de la requête

workstationtexteobligatoire
Le poste où la carte est insérée.
typeénumérationobligatoire
read_vitale, read_cps ou secure_claim.
read_vitaleread_cpssecure_claim
scenariotexteou null
En mode test, le scénario que répond le simulateur. Voir /v1/test-helpers/scenarios.
claimtexte
La facture à sécuriser, pour secure_claim seulement. Elle doit être ready.

En-têtes

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

Réponse

Rend l’objet demandes aux postes.

Une erreur suit le format commun.

Requête

curl


curl -X POST https://api.ophelix.fr/v1/workstation-actions \
  -H "Authorization: Bearer sk_test_…" \
  -H "Content-Type: application/json" \
  -d '{
    "workstation": "ws_…",
    "type": "read_vitale",
    "scenario": "vitale_ok"
  }'

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.ophelix.fr']);
 
$response = $client->post('/v1/workstation-actions', [
    'headers' => ['Authorization' => 'Bearer sk_test_…'],
    'json' => [
        'workstation' => 'ws_…',
        'type' => 'read_vitale',
        'scenario' => 'vitale_ok',
    ],
]);
$object = json_decode((string) $response->getBody(), true);

TypeScript


const response = await fetch('https://api.ophelix.fr/v1/workstation-actions', {
  method: 'POST',
  headers: { Authorization: 'Bearer sk_test_…', 'Content-Type': 'application/json' },
  body: JSON.stringify({
    workstation: 'ws_…',
    type: 'read_vitale',
    scenario: 'vitale_ok'
  }),
})
const object = await response.json()

Réponse 201


{
  "id": "obj_…",
  "object": "workstation_action",
  "type": "read_vitale",
  "status": "pending",
  "workstation": null,
  "browser_session": null,
  "scenario": null,
  "claim": null,
  "result": null,
  "failure_code": null,
  "failure_message": null,
  "expires_at": null,
  "started_at": null,
  "completed_at": null,
  "created": 1793970000,
  "livemode": false
}