レストAPI
サーバー間の呼び出しには、`Authorization: Bearer esk_test_…` または `esk_live_…` が使用されます。テナントはキーから来ます。アップロード、エンベロープ ウィザード、および webhook 登録には管理者セッションが使用されます。
テナント API キーが呼び出せるもの
| 電話 | キーのスコープ | 得られるもの |
|---|---|---|
| GET /api/v1/zapier/auth/test | integrations:zapier | テナント ID と名前。キーを確認する場合に使用します。 |
| GET /api/v1/zapier/triggers/{event}/sample | integrations:zapier | document.signed、document.completed、document.expired、template.created のサンプル ペイロード。 |
| POST /api/v1/zapier/actions/create-from-template | integrations:zapier | 既存のテンプレートからの新しいドキュメント ID。 |
| POST /api/v1/zapier/actions/send-for-signing | integrations:zapier | 文書はリンク送信に移動し、署名者に電子メールが送信されます。 |
| POST /api/v1/signing-sessions/{sessionId}/tokens | signing:write | 埋め込み用の短期間の st_… トークン。ブラウザは、API キーではなく、そのトークンを使用します。 |
管理者セッション
これらの管理アプリにサインインします。これらのルート上のベアラー API キーは拒否されます。
| 仕事 | どこ |
|---|---|
| PDF、顧客、テンプレートをアップロードします | 管理書類と顧客 |
| エンベロープウィザード: 作成、送信、キャンセル | 管理用エンベロープ |
| webhookの登録、回転、再生 | 管理者 → 開発者 → Webhooks |
キーを確認し、テンプレート文書を送信
前提条件: `integrations:zapier` を含む `esk_test_…` または `esk_live_…` キー、およびテンプレート ID。予期される出力: 認証テストからの HTTP 200、`documentId` を含む HTTP 201、次に `status: "link-sent"`。
curl -sS https://api.endorsedsign.com/api/v1/zapier/auth/test \
-H "Authorization: Bearer $ENDORSED_API_KEY"
curl -sS -X POST https://api.endorsedsign.com/api/v1/zapier/actions/create-from-template \
-H "Authorization: Bearer $ENDORSED_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"templateId": "'"$ENDORSED_TEMPLATE_ID"'",
"recipientEmail": "signer@example.com",
"recipientName": "Signer Example"
}'
curl -sS -X POST https://api.endorsedsign.com/api/v1/zapier/actions/send-for-signing \
-H "Authorization: Bearer $ENDORSED_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"documentId": "'"$ENDORSED_DOCUMENT_ID"'",
"channel": "email"
}'新しい統合では、`/api/v1/…` または `/api/v2/…` を呼び出す必要があります。 `/api/v2` は 2026-09-01 の契約です。それをサポートする変更呼び出しでは、「冪等性キー」を送信する必要があります。
よくある質問
API キー
名前付きキーを作成し、スコープを割り当て、オペレーターがすでに使用しているのと同じ管理クロムでプレフィックスを確認します。

SDK クイックスタート
オペレーターはキーをローテーションし、同じテナント開発者ワークスペースから言語固有のSDKオンボーディングを引き渡すことができます。

ライブデータを含む開発者ワークスペース
管理ワークスペース内のアクティブなテナントAPI キー コントロールを表示する単一の開発者画面。

1 回の通話で API キーを取得します
POST /api/auth/register with `mode: sandbox` returns an `esk_test_` key. Confirm it with GET /api/v1/zapier/auth/test. OpenAPI is at /api/docs.json on an API host that has docs enabled.