Environnement d'essai

Une intégration s'essaie avec l'API réelle, dans une organisation qui n'est pas encore en production. Toute organisation naît ainsi, en démonstration : ses parcours sont des parcours d'essai, sans consommation de crédits, et les services payants y sont refusés. Dans une organisation en production, un parcours se lance aussi en essai, à la demande.

Le statut d'une organisation

GET https://staging-api.docage.com/Organizations/{id} le donne, dans OrganizationStatus :

• Une organisation naît en démonstration, qu'elle soit créée par l'inscription en ligne ou par son intégrateur. Elle n'en sort pas d'elle-même.
• Elle passe en production quand un administrateur souscrit depuis l'application (bandeau « Devenir client »), à la fin du parcours d'abonnement — un abonnement en cours compte encore comme une démonstration —, ou par son intégrateur : PUT https://staging-api.docage.com/Organizations/{id} avec "OrganizationStatus": 2. Seul un gestionnaire des clients de l'intégrateur de l'organisation peut le faire ; envoyée par un autre utilisateur, la valeur est ignorée sans erreur. Une organisation dont l'intégrateur n'est pas lui-même en production ne peut pas y passer (400).

Ce qui change avant la production

Les parcours sont des parcours d'essai. IsTest est posé au lancement, quel que soit le corps envoyé :

• aucun crédit n'est contrôlé ni consommé ;
• les documents et le fichier de preuve portent un filigrane « TEST » suivi du nom de la marque : ils n'ont pas de valeur probante ;
• un participant ne reçoit pas de code de sécurité par téléphone (SMS ou WhatsApp) : il signe ou valide avec un code reçu par email. Le lancement d'un parcours dont un participant recevrait son code par SMS est refusé : « … recevrait son code de sécurité par SMS, ce qu'une organisation hors production ne permet pas — choisissez le mode de signature « Email » » ;
• un parcours qui comporte une vérification d'identité ne se lance pas : « Votre organisation n'est pas en production : elle ne peut pas lancer un parcours comportant une vérification d'identité, qui est un service payant. Retirez cette action, ou passez votre organisation en production pour lancer ce parcours. »

Les services payants sont refusés, avec le même message : « Votre organisation n'est pas en production : … n'est pas disponible, car c'est un service payant. Passez en production pour l'utiliser. » C'est le cas de l'envoi d'un SMS (campagnes comprises), d'un horodatage, d'une vérification d'identité hors parcours, de la vérification d'une personne morale, de la vérification d'un numéro par SMS, de l'envoi d'un lien de paiement ou d'un code d'accès au portail par SMS, et de l'enregistrement d'une réunion. Une commande de crédits est refusée aussi.

Les transferts ont des bornes plus étroites, figées à l'envoi :

GET https://staging-api.docage.com/Transfers/Limits rend les bornes qui s'appliquent à l'organisation de l'utilisateur. L'email reçu par un destinataire dit que les fichiers viennent d'un compte d'essai.

L'assistant IA de l'utilisateur s'y essaie dans une limite quotidienne.

Ce qui ne change pas

• Les emails partent pour de vrai : invitations, relances, notifications. Faites participer des adresses que vous lisez, jamais celles de vrais clients.
• Les webhooks sont appelés comme en production ; POST https://staging-api.docage.com/Webhooks/{id}/Test en envoie un tout de suite.
• Un paiement est réel ou d'essai selon son compte de paiement (IsLive), pas selon le statut de l'organisation.

Un parcours d'essai dans une organisation en production

Posez "IsTest": true sur le parcours, à sa création — dans le corps de POST https://staging-api.docage.com/Transactions/CreateFullTransaction comme dans celui de POST https://staging-api.docage.com/Transactions. Il ne se change plus une fois le parcours lancé.

• Aucun crédit n'est consommé, ni rendu à son annulation ; les documents et la preuve sont filigranés, sans valeur probante, et ne sont pas archivés.
• Les codes de sécurité par SMS ou WhatsApp partent, sans être facturés.
• Un parcours d'essai ne se publie pas sur un portail.
• Une vérification d'identité n'est pas couverte par l'essai : elle est facturée.

Nettoyer après un essai

• DELETE https://staging-api.docage.com/Transactions/{id}, ou DELETE https://staging-api.docage.com/Transactions/BatchDelete avec la liste des identifiants, met des parcours à la corbeille. Un parcours en cours est d'abord annulé, avec les suites de toute annulation.
• DELETE https://staging-api.docage.com/Transactions/BatchDefinitivelyDelete supprime définitivement des parcours déjà à la corbeille ; une fiche qui n'y est pas est refusée.
• Les autres fiches se suppriment de même, à l'adresse de leur liste — voir Créer et modifier. Donner un ExternalId reconnaissable à ce que crée un essai permet de tout retrouver ensuite par un filtre — voir Rejouer une requête sans doublon.