开发者
休息API
服务器到服务器的调用使用“授权:承载 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、客户、模板 | 管理文档和客户 |
| 信封向导:创建、发送、取消 | 管理信封 |
| 注册、轮换和重播webhooks | 管理员 → 开发者 → Webhooks |
确认密钥,然后发送模板文档
先决条件:带有“integrations:zapier”的“esk_test_...”或“esk_live_...”密钥以及一个模板 ID。预期输出:来自身份验证测试的 HTTP 200,带有 `documentId` 的 HTTP 201,然后是 `status: "link-sent"`。
bash
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关键控件。

一通电话即可获取您的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.