メインコンテンツへスキップ
人がブラウザでサインインしなくても、API キーを使って、スクリプトや CI で expl server を実行します。

API キーを作る

CI は、変更のたびに自動で処理を流す仕組みです。人がブラウザでサインインできないので、API キーを渡します。作り方は、API キーのページにあります。 作ったキーは、CI のシークレット(値を隠して保管する機能)に登録します。スクリプトには書かず、画面やログにも出さないでください。キーには有効期限があります。それまでに新しいキーを作って、シークレットを入れ替えます。 キーの作り方と安全な扱い方は、API キーを参照してください。

キーを渡す

キーは、環境変数 EXPL_SERVER_TOKEN で渡します。保存したログイン情報との順は、サインインを参照してください。接続先を変えるときは、EXPL_SERVER_URL を設定します。

実行例: GitHub Actions

GitHub Actions の例です。<id> は、読みたいコンテンツの id に置き換えます。<version> は、使うバージョン番号に置き換え、必ず固定します。

終了コード

スクリプトでは、終了コードによって成功か失敗かを判断できます。CI で特に多いのは、次の 2 つです。 すべての終了コードは、終了コードとエラーで説明しています。

API キーを取り消す

漏れたキーや使わなくなったキーは、API キーの手順で取り消します。 取り消した、または期限切れのキーでの呼び出しは、終了コード 4 で終了します。