Skip to Content
RéférenceDemandes aux postesL’objet

Demandes aux postes

Une lecture de carte ou une signature confiée à un poste. L’agent la relève, l’API l’exécute.

Le cycle de vie et les pièges : Pages web.

Événements : workstation_action.*.

Routes

RouteEffet
POST /v1/workstation-actionsDemander une lecture ou une signature à un poste
GET /v1/workstation-actions/{workstationAction}Lire une demande à un poste
GET /v1/workstation-actionsLister les demandes aux postes
POST /v1/workstation-actions/{workstationAction}/cancelAnnuler une demande à un poste

L’objet

  • idtexte

    L'identifiant de l'objet, préfixé par son type.

  • objecttexte

    Le nom du type d'objet.

  • typeénumération

    read_vitaleread_cpssecure_claim

  • statusénumération

    pending tant que l'agent ne l'a pas prise, in_progress pendant la lecture, puis succeeded, failed, canceled, ou expired si personne ne l'a prise à temps.

    pendingin_progresssucceededfailedcanceledexpired

  • workstationtexteou null
  • browser_sessiontexteou null

    La session de la page qui l'a demandée, vide si c'est un serveur.

  • scenariotexteou null

    Le scénario du simulateur, en mode test. Sans lui, vitale_ok ou cps_doctor.

  • claimtexteou null

    La facture à sécuriser, pour secure_claim.

  • resultobjetou null

    Ce que la demande a produit, par identifiant : coverage et patient pour une carte Vitale, practitioner pour une CPS, claim pour une signature. À relire avec la clé secrète : la demande ne porte aucune donnée de la carte.

    Champs de result
    • coveragetexte
    • patienttexte
    • practitionertexte
    • claimtexte
  • failure_codetexteou null

    card_absent, declined, ou le code d'erreur du moteur (card_unreadable, engine_unavailable…).

  • failure_messagetexteou null
  • expires_atentierou null
  • started_atentierou null
  • completed_atentierou null
  • createdentierou null

    La création de l'objet, en secondes Unix.

  • livemodebooléen

    true en production, false en mode test.

L'objet
{ "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 }
Mis à jour le