他のソフトウェアと連携する

スクリプト、ボット、他のシステムから2novelを操作したい場合に、連携を使います。アプリケーション内で翻訳や編集をするだけなら、APIキーやWebhookは不要です。

「設定」→「連携」→「2novel APIキー」へ進みます。利用できるかどうかは、ワークスペースの機能によって異なります。

1. キーを作成し、使用するソフトウェアにちなんだ名前を付けます。
2. 一度だけ表示されるタイミングでコピーし、シークレットストアか、非公開の受信側の設定に保管します。公開されるフロントエンドのコードには決して入れないでください。
3. APIリファレンスを参照して、認証付きのリクエストを送ります。
4. 使っていないキーは取り消します。キーを紛失した場合は新しく作成してください。以前のキーの平文を再び表示することはできません。

Webhookは、作品に更新があったことを知らせるものです。章の全文は含まれません。受信側は、必要なデータをAPIで取得します。

1. 「Webhook通知」を開き、管理しているパブリックなHTTPSエンドポイントを登録します。
2. 受信側に必要なイベントを選びます。
3. 一度だけ表示される署名シークレットを保存し、受信側で署名検証を設定します。
4. テストを送信し、レスポンスコードを確認して、受信側のログを調べます。成功のレスポンスだけでは、署名検証が機能している証明にはなりません。
5. 配信状況を監視します。メンテナンス中は一時停止し、受信側の準備ができたら再開します。

署名シークレットをローテーションしたら、受信側で新しいシークレットを使う必要があります。速やかに更新してください。Webhookを削除すると、以降の配信は停止します。生のボディでの署名検証とレスポンスの扱いについては、APIリファレンスを参照してください。