バックエンドとデータ
シークレットとAPIキー
アプリがほかのサービスとやり取りするための秘密のキーを保存し、安全に守る方法と、プレビューや公開中のアプリにどう届くかを説明します。
シークレットとは、アプリには必要だけれど、ほかの人には見せてはいけない秘密の値のことです。たいていはAPIキーやトークンで、地図、天気、ショートメッセージなどのサービスが、アプリから使えるように渡してくれるパスワードのようなコードです。
シークレットはアプリのコードには含まれません。Buildliyが別の場所に暗号化して保管し、アプリのサーバーが動くときに渡します。そのため、コードにも、GitHubにも、訪問者がダウンロードするページにも、シークレットが現れることはありません。
シークレットが安全に守られるしくみ
- 保存時に暗号化。 Buildliyは、すべてのシークレットを暗号化してから保存します。
- サーバーだけ。 シークレットを読めるのは、アプリのサーバー側のコードだけです。訪問者のブラウザに送られることはありません。
- 二度と表示されません。 保存したシークレットの値は、あとから見ることができません。置き換えることだけができます。
- オーナーだけ。 管理 → シークレットでシークレットを見たり変更したりできるのは、プロジェクトのオーナーだけです。共有しているアプリでは、チームメンバーもAIのキーカードに答えられますが、すでに誰かが保存したキーを置き換えることはできません。
AIがキーを求めてきたとき
お願いした機能にキーが必要な場合、AIは作業をいったん止めて、チャットにカードを表示します。カードには2種類あります。
接続カードは、Resend、Twilio、Airtable、SendGridなど、Buildliyのコネクタ一覧にあるサービス用です。(サービス名)を接続 をクリックして、キーを追加してください。Buildliyは、保存する前にそのキーがサービスで使えるかを確認し、暗号化して保管します。さらに、あなたのアカウントにも保存するので、ほかのアプリでも使えます。接続が終わると、AIがビルドを再開します。以前そのサービスに接続したことがあるものの、このアプリではまだオンになっていない場合は、ボタンの表示が (サービス名)で続ける に変わります。すでに接続済みで、このアプリでもオンになっている場合は、AIがそのまま使うので、カードは表示されません。今はスキップを押すと、何も接続せずにカードが閉じます。AIは「コネクタのページからいつでも接続できます」と返事をして、次のメッセージを待ちます。くわしくはコネクタをご覧ください。
キーカードは、それ以外のキー用です。AIからの質問と、キーの 保存名(たとえば WEATHER_API_KEY)、そしてキーを貼り付けるための入力欄が表示されます。
サービスからキーを入手する
サービスのウェブサイトにログインして、APIキーをコピーします。何のためのキーかは、たいていカードの質問に書かれています。
カードに貼り付ける
入力欄にキーを貼り付けます。貼り付けた内容を確認したいときは、目のアイコンをクリックしてください。画面を共有する前には、もう一度隠しておきましょう。
保存をクリックする
キーは暗号化されて保存されます。カードにも「安全に暗号化して保存しました。チャットにもアプリのコードにも表示されません。あとから 管理 → シークレット で変更できます。」と表示されます(チームメンバーには「プロジェクトのオーナーがあとから変更できます。」と表示されます)。このあと、AIはそのキーを使ってビルドを続けます。
スキップをクリックすると、何も保存されず、AIはキーなしで作業を続けます。そのキーが必要な機能は、管理 → シークレットでキーを追加するまで動きません。
支払いの受け付けは、設定のしかたが異なります。くわしくは支払いを受け付けるをご覧ください。
キーをチャットに貼り付けないでください
チャット欄に入力した内容は、会話の中に保存され、AIにも読まれます。シークレットのように隠されたり暗号化されたりはしません。キーを渡すときは、必ずキーカードか 管理 → シークレットを使ってください。
うっかりキーを貼り付けてしまったとき
Buildliyは、チャット欄にシークレットキーが入っていないかをチェックしています。たとえばStripeのシークレットキー、GitHubのトークン、パスワード付きのデータベースのアドレスなどです。キーが入ったメッセージは送信されません。キーを貼り付けた直後、または送信を押した直後に、チャット欄の上に シークレットキーのようです というカードが表示されます。カードには、キーの種類が(キーの大部分を隠した状態で)表示され、次の選択肢が出ます。
- シークレットとして保存:保存する名前 に入力した名前(たとえば
STRIPE_SECRET_KEY)で、管理 → シークレットに保存します。名前は変更できます。キーがコネクタ一覧にあるサービスのものなら、あなたの…コネクタとして保存(Buildliyが使えるかを確認して、あなたのアカウントに保存するので、ほかのアプリでも使えます)と、このアプリのシークレットとして保存のどちらかを選べます。共有ワークスペースでは、先にチェックボックスにチェックを入れて、このアプリでビルドするチームメンバーがその接続を使えることを確認します。 - メッセージを編集:カーソルがキーの位置に移動するので、キーを取り除けます。キーが入っている間は、メッセージは送信されません。
- キーではないのでそのまま送る:メッセージをそのまま送ります。カードの判断が間違っている、まれな場合のためのボタンです。
保存が終わると、メッセージの中のキーは [saved as STRIPE_SECRET_KEY] に置き換わるので、残りのメッセージは安心して送れます。保存できるのはプロジェクトのオーナーだけです。チームメンバーには キーを取り除く が表示され、カードには、オーナーに 管理 → シークレットで追加してもらうよう案内が出ます。アプリがまだない状態のホームページでは、とりあえずキーを取り除くための選択肢が表示されます。
Stripeの公開可能キー(pk_…)のように、公開しても問題のないキーは対象になりません。シークレットキーが入ったWord、Excel、テキストのファイルを添付した場合は、そのキーがAIから見えないように隠されます。
それでもキーがチャットで送信されてしまった場合は、漏れてしまったものとして扱ってください。サービスのウェブサイトで新しいキーを作って古いキーを削除し、新しいキーを管理 → シークレットに保存してください。
シークレットを自分で追加・変更・削除する
シークレットを開く
管理タブを開いて、シークレットを選びます。
新しいシークレットを追加に入力する
新しいシークレットを追加の下に、大文字とアンダースコアで書いた 名前(例:
WEATHER_API_KEY)と 値 を入力します。何のためのものかを思い出せるように、説明 も入力できます(入力は任意です)。保存する
保存をクリックします。保存済みのシークレットの下に表示されます。
名前は、アプリのコードが使っている名前と同じにする必要があります。わからないときは、AIにどの名前を想定しているか聞いてみましょう。
天気ウィジェットは、どのシークレット名からキーを読み込んでいますか?
- シークレットを変更する。 円形の矢印アイコン(このシークレットを入れ替える)をクリックし、新しい値を貼り付けて、入れ替えるをクリックします。画面が広いときは、入れ替え回数の列に、そのシークレットを何回ローテーションしたかが表示されます。
- すでにある名前で保存する。 保存済みの名前と同じ名前でシークレットを保存すると、古い値が置き換わります。Buildliyは、先に確認を出します。プレビューはすぐに新しい値に切り替わり、公開中のアプリは、もう一度公開するまで古い値のままです。古いままにするか置き換えるかを選んでください。
- シークレットを削除する。 ゴミ箱アイコン(このシークレットを削除)をクリックして、確認します。アプリはそのシークレットを使えなくなります。プレビューではすぐに、公開中のアプリでは次に公開したときからです。
プレビューと公開中のアプリでのシークレット
- プレビューは、新しく追加したり、変更したり、削除したりしたシークレットを自動で反映します。ビルドし直す必要はありません。
- 公開中のアプリがシークレットを受け取るのは、公開するときです。シークレットを変更したら、もう一度公開して、公開中のサイトに新しい値を反映させてください。アプリが公開中の場合は、管理 → シークレットで変更したあとや、チャットのカードからキーを保存したあとに表示されるメッセージで、再公開をお知らせします。
シークレットとコネクタ
どちらもキーを安全に保管します。違いは、保管される場所と、使える人です。
| コネクタ | シークレット | |
|---|---|---|
| 保存される場所 | あなたのBuildliyアカウント | 1つのアプリの中 |
| 使えるアプリ | 初期設定では、あなた自身のすべてのアプリ(特定のアプリだけオフにするには、管理 → コネクタ で切り替えます)。チームと共有しているアプリでは、そこでオンにしたときだけ | このアプリだけ |
| 保存前の確認 | あり。Buildliyがサービスでキーを試します | なし |
| 向いているもの | 複数のアプリで使う、コネクタ一覧にあるサービス | それ以外のキー、または1つのアプリだけで別のキーを使いたいとき |
シークレットとコネクタが同じ名前の場合、そのアプリではシークレットが優先されます。1つのアプリだけ別のキーを使いたいときに便利です。
Buildliyが自動で追加するキー
一部の機能では、シークレットが自動で追加されます。アプリでアプリ内のAIを使っていると、BUILDLIY_API_KEY と BUILDLIY_API_URL が表示されます。支払いを受け付けていると、BUILDLIY_API_KEY と BUILDLIY_WEBHOOK_SECRET が表示されます。訪問者によるファイルのアップロードやエラーの報告を使っていると、BUILDLIY_API_KEY と BUILDLIY_API_URL が表示されます。スケジュールジョブがある場合は、BUILDLIY_CRON_SECRET が表示されます。これらは変更したり削除したりしないでください。それらの機能が動かなくなります。