開発者向け API · 更新日
自社のプロダクトに署名機能を組み込む。
PDF、Word ファイル、テンプレートから文書を作成し、署名依頼を送り、ステータスを確認し、署名されたら Webhook で通知を受け取る。すべてコードから行えます。
REST API
Webhook
API キー
eSignSimple の API は公開されていますか?
自社のソフトウェアから、誰もダッシュボードにログインすることなく、文書の作成、署名依頼の送信、ステータスの確認、署名済みコピーのダウンロードができるようになりました。REST API のエンドポイントは https://esignsimple.com/api/v1 で、リクエストとレスポンスの例を含む完全なリファレンスは開発者向けページにあります。
API 経由で依頼を受けた署名者も、ダッシュボードから送った文書とまったく同じく、アカウント不要で署名でき、同じ証拠が残ります。監査証跡、署名証明書、そして当社の公開検証ページで誰でも確認できる SHA-256 ハッシュです。
API はどう動くのか?
POST /documents で文書を作成します。PDF と、署名者と入力欄を列挙した JSON パートを含むマルチパートリクエストを送ります。入力欄の位置はページに対する割合で指定するため、PDF のポイントやページサイズを気にする必要はありません。文書はすぐに送信されますが、send:false を指定すれば下書きとして保存されます。
ダッシュボードにテンプレートがすでにある場合は、POST /templates/{id}/send で署名者を入力して送信できます。GET /documents はステータスでの絞り込みと before によるカーソル方式のページングで文書を一覧表示します。GET /documents/{id} はステータス、署名者、監査証跡の全体を返し、GET /documents/{id}/download は文書の完了後に署名済み PDF を、?file=original を付ければ元のファイルを返します。
さらに、POST /documents/{id}/void で進行中の文書を無効にし、DELETE /documents/{id} で文書を削除し、GET /me でプランと現在の使用量を確認できます。
認証と API キーはどう機能するのか?
すべてのリクエストで Bearer 形式の API キーを使います。キーは「設定 → 開発者」で作成・失効できます。キーが表示されるのは作成時の一度だけで、当社はハッシュしか保存しないため、すぐにシークレット管理ツールにコピーしてください。キーが漏えいしたら、失効させて新しいキーを作成するだけです。他に変更すべきものはありません。
同じ API は Firebase ID トークンも受け付けます。これは今後公開予定のモバイルアプリが使う方式です。これは意図的な選択です。私たちは自社のアプリを、皆さんが使うのと同じ公開 API の上に作っているため、API は毎日実際に使われて鍛えられています。
どんな Webhook を受け取れるのか?
ポーリングする代わりに、アカウントに HTTPS のエンドポイントを1つ登録しておけば、何かが起きたときに当社から通知します。イベントは document.completed、document.declined、document.voided、signer.signed です。
各配信は HMAC-SHA256 で署名され、その署名は esign-signature ヘッダーで送られるので、処理する前にリクエストが本当に当社から来たものか確認できます。エンドポイントが失敗した場合は1回だけ再試行します。私たちのアドバイス:Webhook はきっかけとして扱い、正確な状態は GET /documents/{id} で取得してください。
API で何が作られているのか?
商談が受注になった瞬間に契約書を送る CRM や見積ツール。採用が確定したらテンプレートから入社書類一式を送る人事システム。賃貸借契約書を送り、document.completed を受け取ったら署名済み PDF を物件ごとに保管する不動産管理ツール。スプレッドシートから契約書へ手作業で行をコピーする作業をなくす社内スクリプト。
週に数件しか文書を送らないなら、API はおそらく必要ありません。ダッシュボードのテンプレート、一括送信、Web フォームを使えば、はるかに少ない手間で対応できます。
API の料金は?
API 専用のプランはありません。Web アプリと同じプランの上限が適用されます。無料プランは毎月5件まで、パーソナルプランは無制限です(料金を参照)。API で作成した文書は、ダッシュボードから送った文書とまったく同じように数えられます。
DocuSign、Dropbox Sign、Adobe などの大手は、API をユーザー向けプランとは別料金にしていることが多く、年間のエンベロープ数に基づく場合が少なくありません。入門向けの API プランでも、通常のサブスクリプションよりかなり高額になることがあります。最新の料金は各社の Web サイトでご確認ください。
まだ含まれていないものは?
足りない部分も正直にお伝えします。埋め込み署名用の iframe はまだないため、署名者は引き続き当社がメールで送るリンクから署名します。公式 SDK はありません。API は素の HTTP と JSON なので、HTTP クライアントがあればどの言語でも使えます。独立したサンドボックス環境もないため、無料アカウントとご自身のメールアドレスでテストしてください。これらはすべてロードマップに入っています。
なぜ小さな API から始めたのか?
私たちはあえて範囲を絞って始めました。よくあるワークフローをきちんとこなし、上限が予測でき、営業との商談も不要な小さな API のほうが、統合に何週間もかかる巨大な API より役に立ちます。必要なものが足りなければ、何を作っているのか教えてください。次に何を追加するかは、実際の統合事例で決めています。
現在どの API エンドポイントがあるのか?
| エンドポイント | 機能 | 典型的な使い方 |
|---|---|---|
| POST /documents | 署名者と入力欄を指定して PDF をアップロードし、送信または下書き保存 | アプリで生成した契約書を送る |
| POST /templates/{id}/send | ダッシュボードのテンプレートを指定した署名者に送る | 採用確定時に入社書類一式を送る |
| GET /documents と GET /documents/{id} | 文書の一覧、またはステータス・署名者・監査証跡の取得 | ステータスを CRM に同期する |
| GET /documents/{id}/download | 署名済み PDF(または元のファイル)をダウンロード | 署名済みコピーをレコードに保管する |
| POST /documents/{id}/void と DELETE /documents/{id} | 文書の取り消しまたは削除 | オファーの撤回や下書きの整理 |
| GET /me | プランと今月の使用量 | 無料プランの上限に達する前に警告する |
よくある質問
eSignSimple に API はありますか?
はい。REST API は https://esignsimple.com/api/v1 で公開されており、Bearer 形式の API キーと Webhook に対応しています。リファレンスは開発者向けページにあります。
API の料金はいくらですか?
API 専用の料金はありません。通常のプランが適用されます。無料プランは毎月5件まで、パーソナルプランは無制限です。
API キーはどうやって取得しますか?
「設定 → 開発者」で作成します。表示されるのは一度だけで、ハッシュ化して保存されるため、すぐに保存してください。キーはいつでも失効できます。
どの Webhook イベントが使えますか?
document.completed、document.declined、document.voided、signer.signed です。esign-signature ヘッダーに HMAC-SHA256 の署名が付き、再試行は1回です。
埋め込み署名、SDK、サンドボックスには対応していますか?
まだ対応していません。3つともロードマップに入っています。現在、署名者はメールで届くリンクから署名し、API は素の HTTP で呼び出します。