ヘルプセンター
API 接続
API Key を作成し、機能確認、生成送信、状態確認、結果取得の順に接続します。
概要
サイトの API Base URL と Bearer API Key を使い、サーバー側から呼び出します。Web と API は同じポイント台帳を共有します。
手順
- 1
API ページで Key を作成し、一度だけ表示される完全な認証情報をサーバー側の秘密管理に保存します。
- 2
最初に機能情報を取得し、その時点で返されたモデルのパラメータと制限に従います。
- 3
論理的な送信ごとに固有の Idempotency-Key を付け、許容上限 maxPoints を設定します。
- 4
返されたタスク識別子で状態を確認し、完了後に結果を取得します。
- 5
配信の expiresAt を確認し、期限前に結果をダウンロードします。
注意事項
- API Key をブラウザー、モバイルアプリ、公開リポジトリに置かないでください。
- 成功時は実際のポイントを消費し、確定失敗時は予約ポイントを解放します。残高が設定された基準未満の場合は送信できません。