API の利用
PocketSign Platform に登録する
PocketSign Stamp API を利用するには、PocketSign Platform への登録が必要です。 登録がお済みでない場合は、PocketSign Platform に登録するを参照してサインアップしてください。
Stamp API の利用開始
Stamp API を利用するには、PocketSign Verify API の API トークンが必要です。 API の利用開始を参照して、API トークンを取得してください。
API の呼び出し方法等については Verify API と共通です。 クライアントライブラリ、ライブラリを使用せずに呼び出す、エラーの処理をご参照ください。
テストリクエストの送信
以下のようなリクエストを送信して、セッションの作成を試してみましょう。
<YOUR_API_TOKEN>
には、前のステップで作成した API トークン、<YOUR_TENANT_ID>
には、前のステップで作成したテナント ID を入力してください。
- Buf CLI
- curl
PocketSign Stamp API は Buf CLI を使用して呼び出すことができます。 Buf のドキュメント Install the Buf CLI を参照して、Buf CLI をインストールしてください。
セッション開始サンプルリクエスト
buf curl 'https://verify.mock.p8n.app/pocketsign.stamp.v1.SessionService/CreateSession' \
-H 'Authorization: Bearer <YOUR_API_TOKEN>' \
-H 'X-Tenant-ID: <YOUR_TENANT_ID>' \
--schema 'buf.build/pocketsign/apis' \
--data '{
"callbackUrl": "https://example.com/callback",
"requests": [
{
"required": true,
"digitalSignature": {
"content": "SGVsbG8K",
"printableContent": "Hello"
}
}
]
}'
セッション開始サンプルリクエスト
curl 'https://verify.mock.p8n.app/pocketsign.stamp.v1.SessionService/CreateSession' \
-H 'Authorization: Bearer <YOUR_API_TOKEN>' \
-H 'X-Tenant-ID: <YOUR_TENANT_ID>' \
-H 'Content-Type: application/json' \
--data '{
"callbackUrl": "https://example.com/callback",
"requests": [
{
"required": true,
"digitalSignature": {
"content": "SGVsbG8K",
"printableContent": "Hello"
}
}
]
}' | jq
リクエストが成功すると、以下のようなレスポンスが返ってきます。
セッション開始サンプルレスポンス
{
"id": "0b482125-86cc-4f63-a736-05b1cbe86685",
"redirectUrl": "https://stamp.mock.p8n.app/#CiRiMGM2NDUxNC00ODNiLTRiYTktODY4MC01ZmMwZGEzOGFmZjQSJDBiNDgyMTI1LTg2Y2MtNGY2My1hNzM2LTA1YjFjYmU4NjY4NQ"
}
最初のセッション開始に成功しました 🎉
次のステップ
実際の PocketSign Stamp API の利用方法については、PocketSign Stamp を用いた身元確認をご参照ください。