開発者

サンドボックス

1 つの API 呼び出しは、分離されたサンドボックス テナントをプロビジョニングし、API キーを作成し、デモ署名者をシードします。早期アクセス キューや手動セットアップは必要ありません。

サンドボックスを請求すると何が発送されるか

サンドボックス フローは、標準のセルフサービス登録エンドポイントのモードです。取得できるものはすべて、実際のプラットフォーム上の実際のテナントです。単に「isSandbox: true」とマークされ、最初の「curl」が成功するように事前シードされています。

🏷️

孤立したテナント

「isSandbox: true」とマークされた、選択した名前の新しいテナント。サンドボックス API キーは他のテナントに対して機能することはなく、他のテナントのキーはあなたのキーに対して機能しません。

🔑

APIキーが1回返されました

登録応答には完全な `esk_test_…` キーが含まれます。これは 1 回表示されます。サーバー シークレット マネージャーに保存するか、[管理者] → [開発者] → [API キー] から別のキーを作成します。

👤

シードデモ署名者

1 つの顧客レコード (`sandbox-signer-){yourTenantId}`) は事前に作成されています。シードが成功すると、「sampleTemplateId」が組み込まれるため、最初のサーバー呼び出しをテンプレートから作成できるようになります。

🆓

無料プラン、課金設定なし

サンドボックス テナントはサーバー側で無料プランにロックされます。登録は請求パイプラインに触れることはなく、「mode: Sandbox」が設定されている場合、リクエスト本文の「planId」は無視されます。

🔔

Webhooks + 開発者コンソール サインイン中に、

管理者→開発者→Webhookでエンドポイントを登録します。失敗した配信を再生し、管理者→開発者→コンソールでAPIリクエストを検査します。

⏳

有効期限は 30 日です

テナントには「expiresAt」ヒントが含まれています (現時点では情報提供であり、施行はフォローアップです)。今日は何も自動削除されません。畑は将来の清掃作業のためにそこにあります。

1 つのリクエストでサンドボックスを要求します

前提条件: 有効な電子メール アドレスと 8 文字以上のパスワード。予想される出力: `tenantId`、`sandbox.apiKey` (1 回のみ表示)、およびシードされた `demoCustomerId` を含む HTTP 201。

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

管理者にサインインする前に、受信トレイから管理者のメールアドレスを確認してください。 API キーはすぐに機能します。検証は人間のコンソールをゲートするだけです。

サンドボックスから本番環境へ

  1. 1

    サンドボックスを請求する

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

  2. 2

    サンドボックスキーを使用してAPIを呼び出します

    GET /api/v1/zapier/auth/test を確認し、テンプレートから作成して署名用に送信します。管理者 → 開発者 → Webhook で webhook を登録し、コンソールで配信を監視します。

  3. 3

    統合チェックリストを確認する

    webhook 署名検証、相関 ID ログ、冪等性を確認します。開発者コンソールの「管理者」→「開発者」にある完全なチェックリスト。

  4. 4

    プロダクションにサインアップする

    準備ができたら、「mode:production」(または標準のサインアップ UI) を使用して、同じエンドポイントを介して別の運用テナントを登録します。サンドボックス テナントはそのままなので、テストを続けることができます。

よくある質問

1 回の通話でサンドボックスを要求します

エンドポイントは今日ライブです。応答本文には、サーバーから確認できる「esk_test_」キーが含まれています。

クイックスタートを読む開発者コンソールを参照