Sandbox API

Un espace de travail sandbox permet d’exercer l’ensemble du flux Subnoto sans les effets d’un envoi réel. En mode sandbox, les enveloppes sont simulées : aucun e-mail d’invitation n’est envoyé, aucun crédit n’est consommé, et les PDF signés utilisent un certificat de test plutôt qu’un certificat de production.

Le mode sandbox est conçu pour les tests d’intégration : essayez vos flux API, la signature intégrée et les webhooks avant de passer en production avec vos clients.

Qu’est-ce qui change en mode sandbox ?

Pas d'e-mails d'invitation

Lors de l’envoi d’une enveloppe, les destinataires ne reçoivent pas d’e-mail d’invitation. Les liens de signature sont tout de même créés pour tester manuellement ou via l’API.

Pas de consommation de crédits

Les envois depuis le webapp ne consomment pas de crédits SES. Les envois via l’API publique ne consomment pas de crédits API.

Signatures de test

Les documents finalisés sont signés avec un certificat de développement. Les vérificateurs PDF externes ne les traiteront pas comme des signatures de production juridiquement opposables.

Vérification SMS simulée

Les demandes d’OTP par SMS réussissent mais aucun SMS n’est envoyé et aucun OTP n’est stocké. Utilisez la vérification par e-mail ou d’autres flux pour tester la signature avec SMS en sandbox.

Prérequis

Un compte Subnoto avec des identifiants API
Accès API via le proxy de chiffrement ou un SDK officiel
Permission de mettre à jour les espaces de travail de votre équipe

Le mode sandbox ne peut être activé ou désactivé que via l’API publique. Le webapp n’expose pas de bascule sandbox dans les paramètres.

Configuration recommandée

Créez un espace de travail dédié aux tests et conservez vos espaces de production en mode normal. N’activez pas le sandbox sur votre espace par défaut sauf si vous l’utilisez uniquement pour les tests.

Activer le mode sandbox

Créer un espace de test (si vous n’en avez pas encore)

curl -X POST http://your-proxy:8080/public/workspace/create \
  -H "Authorization: Bearer $ACCESS_KEY:$SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Tests integration",
    "colorHex": "#6366F1"
  }'

Conservez le workspace.uuid de la réponse. Les nouveaux espaces démarrent avec "sandbox": false.

Activer le mode sandbox

curl -X POST http://your-proxy:8080/public/workspace/update \
  -H "Authorization: Bearer $ACCESS_KEY:$SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "workspaceUuid": "your-workspace-uuid",
    "sandbox": true
  }'

Confirmer le drapeau

Listez ou récupérez l’espace et vérifiez que "sandbox": true :

curl -X POST http://your-proxy:8080/public/workspace/list \
  -H "Authorization: Bearer $ACCESS_KEY:$SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Exécuter vos tests

Créez des enveloppes, envoyez-les, ouvrez les liens de signature, déclenchez les webhooks et téléchargez les résultats - le tout sans consommer de crédits ni envoyer d’e-mails aux destinataires réels.

Désactiver le sandbox une fois terminé

curl -X POST http://your-proxy:8080/public/workspace/update \
  -H "Authorization: Bearer $ACCESS_KEY:$SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "workspaceUuid": "your-workspace-uuid",
    "sandbox": false
  }'

Avec le SDK TypeScript (connexion directe à https://enclave.subnoto.com) :

const { data, error } = await client.POST("/public/workspace/update", {
    body: {
        workspaceUuid: "your-workspace-uuid",
        sandbox: true
    }
});

Utiliser le webapp dans un espace sandbox

Les membres de l’équipe peuvent utiliser un espace sandbox dans le webapp comme tout autre espace : téléverser des documents, ajouter des destinataires, envoyer des enveloppes et suivre l’avancement. Les mêmes règles sandbox s’appliquent lors d’un envoi depuis le webapp.

Quelques comportements diffèrent dans le webapp :

Signer en personne n’est pas disponible dans les espaces sandbox. Consultez Signer en personne pour le flux de production.
Il n’y a actuellement aucun badge sandbox dans l’interface webapp. Vérifiez le champ sandbox via l’API si vous devez confirmer quels espaces sont en mode test.

Ce qui se comporte normalement

Les membres, rôles et l’isolation des documents fonctionnent comme dans un espace normal. Voir Isoler les documents avec les espaces de travail.
L’OTP par e-mail pour la signature est toujours envoyé en mode sandbox (seul l’OTP SMS est simulé).
Les webhooks se déclenchent comme d’habitude, ce qui permet de tester votre automatisation de bout en bout.
Les rappels automatiques peuvent encore envoyer de vrais e-mails si configurés sur l’enveloppe. Désactivez les rappels sur les enveloppes de test, ou utilisez des adresses que vous contrôlez.

Dépannage

Ressources associées

Isoler les documents avec les espaces de travail - Créer et organiser les espaces
Créer et envoyer votre première enveloppe - Flux API de base à tester en sandbox
Créer des clés API - Identifiants pour l’API publique
Référence API - Documentation complète des endpoints, dont la mise à jour d’espace

En résumé : Créez un espace de test dédié, définissez sandbox: true via l’API publique, exécutez vos tests d’intégration sans e-mails ni crédits, puis repassez à sandbox: false avant la production.