Developer API と webhook を使う

Dashboard の API ページでは、アバター、音声、音声生成、動画生成へプログラムからアクセスできます。Dashboard → API を開くと、現在のベース URL、認証形式、API キー管理、webhook 設定、完全な開発者リファレンスへのリンクを確認できます。

API キーを作成できる人

Developer API へのアクセスは有料プランで利用できます。API キーカードにプランが必要という表示がある場合は、キーを作成する前に Billing からアップグレードしてください。API アクセスと通常のダッシュボードへのサインインは別です。API キーはソフトウェア用の秘密の認証情報であり、人に共有するパスワードではありません。

API キーを作成して保管する

Dashboard → API を開き、Developer API カードを見つけます。
「production backend」や「staging integration」など、識別できるキー名を入力して Create を選びます。
完全なキーをすぐにコピーし、デプロイ環境のシークレットマネージャーまたは保護された環境設定に保存します。
一度だけ表示される画面を閉じると、ダッシュボードにはプレフィックスと利用メタデータだけが残ります。完全なキーは再表示できません。

API キーはアカウントのクレジットを消費できるパスワードと同じように扱ってください。ブラウザーコード、モバイルアプリ、スクリーンショット、チャットメッセージ、公開リポジトリ、クライアント側の環境変数に決して入れないでください。

リクエストを認証する

API ページには現在のベース URL と Authorization ヘッダーの形式が表示されます。信頼できるサーバー側コードからのみ Authorization: Bearer <key> で API キーを送信してください。統合を作る前に、エンドポイント、リクエスト本文、タスクのポーリング、レスポンス形式、レート制限、現在のエラーコードを開発者リファレンスで確認します。

キーをローテーションまたは取り消す

安全に実施できる場合は、先に代替キーを作成してデプロイします。
古いキーを使うすべてのサービスを更新し、リクエストが成功していることを確認します。
Dashboard → API の古いキーの横にある revoke 操作を使います。

取り消しは元に戻せません。完全な値を再確認したいという理由だけでキーを取り消さず、代わりに新しいキーを作成してください。

生成 webhook を設定する

Dashboard → API の Webhook カードに、自分のサーバーが管理する公開 HTTPS エンドポイントを入力します。
Save を選びます。新しいエンドポイントや変更後のエンドポイントを保存すると webhook シークレットが一度だけ表示されることがあるため、すぐにコピーして保管します。
サーバー側でそのシークレットを使い、生のリクエスト本文に対して HMAC-SHA256 を計算し、イベントを受け入れる前に X-Odrazio-Signature ヘッダーと比較します。
イベントで該当リソースをサーバー側から取得するか、ジョブ記録を更新します。検証されていない受信リクエストを、生成完了の証拠として扱わないでください。

webhook を変更または削除する

webhook URL を変更して保存するとシークレットがローテーションされる場合があるため、同時に検証設定を更新してください。配信が不要になったら Remove を使います。有効な URL は公開 HTTPS で到達可能である必要があります。ローカル開発専用のアドレスではプラットフォームのコールバックを受信できません。