Entwickler

Sandkasten

Ein API-Aufruf stellt einen isolierten Sandbox-Mandanten bereit, prägt einen API-Schlüssel und setzt einen Demo-Signer ein – keine Early-Access-Warteschlange, keine manuelle Einrichtung.

Was wird versendet, wenn Sie eine Sandbox beanspruchen?

Der Sandbox-Flow ist ein Modus auf dem standardmäßigen Self-Service-Registrierungsendpunkt. Alles, was Sie erhalten, ist ein echter Mandant auf der echten Plattform – einfach mit „isSandbox: true“ markiert und voreingestellt, damit Ihr erster „Curl“ erfolgreich ist.

🏷️

Isolierter Mieter

Ein neuer Mieter mit dem von Ihnen gewählten Namen, gekennzeichnet mit „isSandbox: true“. Sandbox-API-Schlüssel funktionieren niemals gegen einen anderen Mieter, und die Schlüssel eines anderen Mieters funktionieren nicht gegen Ihren. Der Schlüssel

🔑

API wurde einmal zurückgegeben

Die Registrierungsantwort enthält den vollständigen Schlüssel „esk_test_…“. Es wird einmal angezeigt – speichern Sie es in Ihrem Server-Secret-Manager oder erstellen Sie ein anderes über Admin → Entwickler → API-Schlüssel.

👤

Gekennzeichneter Demo-Unterzeichner

Ein Kundendatensatz („Sandbox-Signer-{yourTenantId}`) ist vorab erstellt. Wenn das Seeding erfolgreich ist, wird „sampleTemplateId“ eingefügt, sodass der erste Serveraufruf „Create-from-Template“ sein kann.

🆓

Kostenloser Plan, keine Abrechnungseinrichtung

Sandbox-Mandanten sind serverseitig an den kostenlosen Plan gebunden. Die Registrierung berührt niemals die Abrechnungspipeline und eine „planId“ im Anforderungstext wird ignoriert, wenn „mode: sandbox“ festgelegt ist.

🔔

Webhooks + Entwicklerkonsole

Registrieren Sie Endpunkte in Admin → Entwickler → Webhooks, während Sie angemeldet sind. Wiederholen Sie fehlgeschlagene Zustellungen und überprüfen Sie API-Anfragen in Admin → Entwickler → Konsole.

⏳

Beratender 30-Tage-Ablauf

Der Mieter trägt einen „expiresAt“-Hinweis (derzeit informativ – die Durchsetzung folgt). Heute wird nichts automatisch gelöscht. Das Feld ist für zukünftige Aufräumarbeiten da.

Beanspruchen Sie eine Sandbox mit einer Anfrage

Voraussetzungen: eine gültige E-Mail-Adresse und ein 8+ Zeichen langes Passwort. Erwartete Ausgabe: HTTP 201 mit Ihrer „tenantId“, „sandbox.apiKey“ (einmal angezeigt) und der gesetzten „demoCustomerId“.

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-…"
#   }
# }

Bestätigen Sie Ihre Admin-E-Mail-Adresse in Ihrem Posteingang, bevor Sie sich bei Admin anmelden. Die API-Taste funktioniert sofort – die Verifizierung öffnet nur die menschliche Konsole.

Von der Sandbox zur Produktion

  1. 1

    Beanspruchen Sie Ihre Sandbox

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

  2. 2

    Rufen Sie den API mit der Sandbox-Taste auf

    Bestätigen Sie GET /api/v1/zapier/auth/test, dann „Create-from-Template“ und „Send-for-Signing“. Registrieren Sie webhooks in Admin → Developer → Webhooks und beobachten Sie Lieferungen in der Konsole.

  3. 3

    Sehen Sie sich die Integrationscheckliste an

    Bestätigen Sie die webhook-Signaturüberprüfung, die Korrelations-ID-Protokollierung und die Idempotenz. Vollständige Checkliste in der Entwicklerkonsole unter Admin → Entwickler.

  4. 4

    Melden Sie sich für die Produktion an

    Wenn Sie bereit sind, registrieren Sie einen separaten Produktionsmandanten über denselben Endpunkt mit „Modus: Produktion“ (oder der Standard-Anmeldeoberfläche). Ihr Sandbox-Mandant bleibt bestehen, sodass Sie weiter testen können.

Häufige Fragen

Beanspruchen Sie Ihre Sandbox in einem Anruf

Der Endpunkt ist heute live. Der Antworttext enthält einen „esk_test_“-Schlüssel, den Sie von Ihrem Server bestätigen können.