- レート制限
- 毎分300リクエスト
- Webhookの署名
- HMAC-SHA256
- リトライ
- 1分から12時間まで
- 冪等性
- 作成操作で対応
開発者
PapelShipは、ダッシュボードでできることのほぼすべてを、APIからも行えるように設計されています。 商品の同期、決済ページの作成、注文の処理、ライセンスの管理、イベントのリアルタイム受信が可能です。一貫したレスポンス形式、きめ細かな権限、信頼性の高いWebhook配信により、初日から本番環境に対応した連携を実現します。
請求書を作成
REST
リクエスト
POST · 作成
Idempotency-Key: 7d1f0c2a-…
レスポンス
請求書を作成しました
X-Request-Id: req_4c1e9a…
レート制限今の分は13件を使用（上限300件）
Webhookの配信
HMAC-SHA256
- 200配信済み
注文イベント
署名済み · 試行 1
- 200配信済み
在庫イベント
署名済み · 試行 1
- 5031分後に再試行
レビューイベント
署名済み · 試行 1
- 200配信済み
出金イベント
署名済み · 試行 1
1分…12時間再試行の期間
機能
本番環境のためのAPI きめ細かなアクセス、予測可能な動作、確実な配信
包括的なREST API
商品、バリエーション、在庫、シリアル番号、ファイル、カテゴリー、請求書、注文、配送と返金、顧客、クーポン、キャンペーン、サブスクリプション、サポートチケット、レビュー、質問、アフィリエイト、Webhookを操作できます。請求書の作成、返金、キャンセル、PDF、配信の再送などの操作もAPIで行えます。
安全で管理されたアクセス
リソースごとに読み取りと書き込みの権限を設定できるAPIキー、読み取り専用キー、有効期限、IPホワイトリストに対応しています。キーごとに、呼び出し回数とエラー数を確認できます。
本番環境のための設計
一貫したレスポンス形式、すべてのリクエストに追跡ID（
X-Request-Id）、作成操作でのIdempotency-Keyに対応。毎分300リクエストの制限があり、レート制限のヘッダーで状況を把握できます。署名付きWebhook
注文、商品、在庫、レビュー、認証、顧客、出金、アフィリエイトのイベントをリアルタイムで受信できます。すべてのリクエストはHMAC-SHA256で署名され、失敗した配信は1分から12時間まで間隔を広げながら自動で再試行されます。配信ログ、手動の再送、テスト送信に対応し、Webhookを直接Discordのチャンネルに送ることもできます。
ブラウザSDKと埋め込みチェックアウト
window.PapelShipSDKで、独自のインターフェースからカート、商品、チェックアウトを操作できます。チェックアウトは、ページとしても埋め込みウィンドウとしても開けます。決済API
ホスト型の決済リンク、アドレス・金額・QRコード付きの暗号資産の請求書、決済状況の確認、返金に対応。OpenAPIスキーマと、専用の署名付きWebhookを備えています。
ライセンスAPI
qPapelライセンスの確認、ハードウェアロックのリセット、凍結、利用停止、期間の追加が可能です。リセラー向けには、別途リセラーAPIを提供しています。
AIエージェント向けMCP
Claude、Cursor、VS CodeなどのAIツールを、OAuthで安全に接続し、テーマのコードを編集させることができます。変更は下書きとして保存され、公開はご自身で行います。
できあいのプラグイン
WooCommerce、XenForo、WHMCS、Magentoなどの決済プラグインを提供しています。
導入の流れ
3つのステップで始められます
- 01
APIキーを作成
必要な権限を選びます。
- 02
Webhookのエンドポイントを追加
テストイベントを送信します。
- 03
連携を本番環境で稼働させる
さらに詳しく
製品、ドキュメント、ガイド 次に読むもの
- ドキュメントクイックスタートアクセスを設定して、最初のリクエストを送信。
- ドキュメント認証APIキーと、リクエストが認可される仕組み。
- ドキュメントStore APIリファレンス商品、注文、顧客など、ストアのすべての機能。
- ドキュメントWebhookストアのイベントを受け取り、署名を検証。
- ドキュメントqPapel APIリファレンス自社のシステムからライセンスを管理。
- ドキュメントAIツール向けMCPAIコーディングツールをテーマのコードに接続。
- ガイドHow to add a checkout widget to your website: embedded checkout for card, crypto and bank transferAdd a checkout widget to your website with one script tag. How embedded checkout works, how to set it up, which payment methods it takes and what happens next.
- ガイドCrypto POS API integration: checkout, in-store terminals and payoutsA developer's guide to crypto POS API integration: create invoices server-side, handle webhooks idempotently, take crypto in store and reconcile payouts.
