メインコンテンツまでスキップ

APIでシステム連携するシークレット​

シークレットは、外部サービスや社内システムと連携する際に必要な認証情報を、安全に管理するための機能です。
APIキー・接続文字列・OAuthクライアントシークレットなどを暗号化して保存し、API定義内から安全に参照できます。

主なユースケース​

ユースケース例
外部APIへのリクエストSlack Webhook URL、決済サービスのAPIキー
外部DBへの接続接続文字列（PostgreSQL、MySQL など）
OAuthクライアント認証クライアントID・クライアントシークレット
メール送信サービスSMTP認証情報、SendGrid APIキー

シークレットの登録手順​

  1. コンソールでチームを選択します。
  2. 「シークレット」 メニューを開きます。
  3. 「新規シークレットを追加」 をクリックします。
  4. 以下の項目を入力します。
項目説明
キー名API定義内で参照するための名前（例: SLACK_WEBHOOK_URL）
値実際のシークレット値（保存後は参照不可）
説明（任意）用途のメモ
  1. 「保存」 をクリックします。
注意

シークレットの値は保存後にコンソール上で確認することはできません。
必要に応じて事前に安全な場所にバックアップしてください。

シークレットの参照方法​

登録したシークレットは、マイクロサービスAPIのカスタムコード（Embed Code）内で環境変数として参照できます。

// シークレット "SLACK_WEBHOOK_URL" を参照する例
const webhookUrl = process.env.SLACK_WEBHOOK_URL;

シークレットの更新・削除​

  • 更新: シークレット一覧から対象のキー名を選択し、新しい値を入力して保存します。
  • 削除: シークレット一覧から対象のシークレットを削除します。削除後、そのキーを参照しているAPIは動作しなくなるため注意が必要です。