Développeurs

Bac à sable

Un appel API provisionne un locataire sandbox isolé, crée une clé API et amorce un signataire de démonstration – pas de file d''attente d''accès anticipé, pas de configuration manuelle.

Qu''est-ce qui est livré lorsque vous réclamez un bac à sable

Le flux sandbox est un mode sur le point de terminaison d''enregistrement libre-service standard. Tout ce que vous obtenez est un véritable locataire sur la vraie plate-forme — il suffit de le marquer « isSandbox : true » et de le pré-amorcer pour que votre premier « curl » réussisse.

🏷️

Locataire isolé

Un nouveau locataire avec le nom que vous avez choisi, marqué « isSandbox : true ». Les clés Sandbox API ne fonctionnent jamais contre un autre locataire, et aucune clé d''un autre locataire ne fonctionne contre la vôtre. Clé

🔑

API renvoyée une fois

La réponse d''enregistrement inclut la clé complète `esk_test_…`. Il est affiché une fois – stockez-le dans le gestionnaire secret de votre serveur, ou créez-en un autre depuis Admin → Développeur → Clés API.

👤

Signataire de la démo prédéfinie

Un enregistrement client (`sandbox-signer-{yourTenantId}`) est pré-créé. Lorsque l''amorçage réussit, `sampleTemplateId` est inclus afin que le premier appel au serveur puisse être créé à partir d''un modèle.

🆓

Forfait gratuit, pas de configuration de facturation

Les locataires Sandbox sont verrouillés sur le plan gratuit côté serveur. L''enregistrement ne touche jamais le pipeline de facturation, et un « planId » dans le corps de la demande est ignoré lorsque « mode : sandbox » est défini.

🔔

Webhooks + console développeur

Enregistrez les points de terminaison dans Admin → Développeur → Webhooks lorsque vous êtes connecté. Rejouez les livraisons ayant échoué et inspectez les requêtes API dans Admin → Développeur → Console.

⏳

Expiration conseillée de 30 jours

Le locataire comporte un indice `expiresAt` (actuellement informatif — l''application est un suivi). Rien n’est automatiquement supprimé aujourd’hui ; le terrain est là pour le futur travail de nettoyage.

Réclamez un bac à sable en une seule requête

Prérequis : une adresse e-mail valide et un mot de passe de plus de 8 caractères. Résultat attendu : HTTP 201 avec votre « tenantId », « sandbox.apiKey » (affiché une fois) et le « demoCustomerId » prédéfini.

bash
curl -sS -X POST https://api.endorsedsign.com/api/auth/register \
  -H 'Content-Type: application/json' \
  -d '{
    "tenantName": "Acme Dev Sandbox",
    "adminEmail": "you@acme.example",
    "password": "your-strong-password",
    "mode": "sandbox"
  }' | jq '.data | { tenantId, sandbox }'

# {
#   "tenantId": "acme-dev-sandbox",
#   "sandbox": {
#     "apiKey": "esk_test_…",             # capture this now — shown once
#     "keyPrefix": "esk_test_…",
#     "keyId": "…",
#     "scopes": ["documents:write", …],
#     "demoCustomerId": "sandbox-signer-acme-dev-sandbox",
#     "demoCustomerName": "Sandbox Signer",
#     "expiresAt": "2026-…"
#   }
# }

Vérifiez votre adresse e-mail d''administrateur depuis votre boîte de réception avant de vous connecter à l''administrateur. La clé API fonctionne immédiatement — la vérification ouvre uniquement la console humaine.

Du bac à sable à la production

  1. 1

    Réclamez votre bac à sable

    POST /api/auth/register with `mode: sandbox`. Capture the returned API key in your secret store.

  2. 2

    Appelez le API avec la touche sandbox

    Confirmez GET /api/v1/zapier/auth/test, puis créez à partir du modèle et envoyez pour signature. Enregistrez les webhook dans Admin → Développeur → Webhook et regardez les livraisons dans la console.

  3. 3

    Consultez la liste de contrôle d''intégration

    Confirmez la vérification de la signature webhook, la journalisation des identifiants de corrélation et l''idempotence. Liste de contrôle complète dans la console du développeur sous Admin → Développeur.

  4. 4

    Inscrivez-vous à la production

    Lorsque vous êtes prêt, enregistrez un locataire de production distinct via le même point de terminaison avec « mode : production » (ou l''interface utilisateur d''inscription standard). Votre locataire sandbox reste en place afin que vous puissiez continuer à tester.

Questions courantes

Réclamez votre bac à sable en un seul appel

Le point de terminaison est en ligne aujourd''hui. Le corps de la réponse comprend une clé `esk_test_` que vous pouvez confirmer depuis votre serveur.