API から Safe Update を実行できるようになりました
自社の保守管理画面などから、サイトごとの更新対象を取得し、プラグインを指定して Safe Update を実行し、結果を受け取れる API を用意しました。Business 以上のプランと OEM のご契約で使えます。
今回のポイント
- 設定の「API」で、チームのオーナーが API キーを発行・無効化できる。読み取りのみのキーと、Safe Update も実行できるキーを分けられる
- サイトごとに、WordPress 本体・テーマ・プラグインの今の版と新しい版を取得できる
- サイトとプラグインを指定して Safe Update を実行できる。承認した版より新しい版が出ていたら、上げずに断る
- 実行の状態(完了・失敗・ロールバック・要確認など)と、項目ごとの更新前と更新後の版を取得できる
- Safe Update の開始と終了を、署名付きの Webhook で登録した URL へ送る。届かなかったときは最大6回送り直す
- API から実行したものは、管理画面の履歴に「API(キーの名前)」と出て、監査ログにも残る
- NexraOne Agent プラグインの更新は不要です
保守を請け負っている制作会社の中には、自社で保守管理の画面を持っていて、どのサイトのどのプラグインを更新するかをそこで決めているところがあります。これまでは、決めた内容を NexraOne の画面で一つずつ選び直して Safe Update を実行する必要がありました。API を使うと、自社の画面から直接 NexraOne に依頼できます。
できること
API キーを使って、サイトの一覧、サイトごとの更新対象、Safe Update の実行、実行の状態と履歴の取得、予約中の実行の取り消しができます。更新の進め方は管理画面から実行したときと同じで、更新前のバックアップ、更新後の確認、問題があったときのロールバックも行います。サイトが落ちているときや、別の Safe Update が動いているときに断る条件も同じです。
更新対象を取得してから実際に実行するまでのあいだに、プラグインの新しい版が出ることがあります。実行の依頼に「この版へ上げる」と書いておくと、その版でなくなっていた場合は更新せずにお知らせします。承認していない版へ勝手に上がることはありません。
結果の受け取り方
Webhook の送信先を登録しておくと、Safe Update が始まったときと終わったときに、結果を送ります。管理画面から実行したものや、自動 Safe Update の結果も届きます。届いた知らせが NexraOne から来たものかは、登録したときに表示される署名用のシークレットで確かめられます。
使えるプラン
Business 以上のプランと、OEM のご契約で使えます。キーの発行と Webhook の登録は、チームのオーナーだけが行えます。呼び出し回数は、キーごとに読み取りが1分に60回、実行などの書き込みが1分に10回までです。
使い方の詳しい説明は、ドキュメントの「API で Safe Update を実行する方法」にまとめています。
NexraOne Agent プラグインの更新は必要ありません。