連携
任意のAPIをつなぐ
コネクタのカタログにないサービスも使えます。キー不要の公開APIから、キーが必要なサービスまで対応でき、AIがビルドに使える自分だけのコネクタも追加できます。
コネクタのカタログには100以上のサービスがそろっています。ただ、APIがあるサービス(ほかのソフトウェアとやり取りするための窓口)なら、ほとんどのものをアプリで使えます。このページでは、いちばん手軽な方法から、くり返し使いやすい方法まで、3つのやり方を紹介します。
| こんなとき | やること |
|---|---|
| APIが公開されていて、キーが要らない | チャットで頼む |
| APIにキーが必要で、1つのアプリでだけ使う | AIにキーをたずねてもらい、そのアプリのシークレットとして保存する |
| 複数のアプリで使う、またはAIにサービスをしっかり理解してほしい | コネクタのページで自分だけのコネクタを作る |
どの方法でも、キーはアプリのサーバー側のコードでしか使われません。そのため、アプリを訪れた人のブラウザにキーが渡ることはありません。
公開APIを使う
天気、祝日、オープンデータなど、キーがまったく要らないサービスはたくさんあります。サービスの名前と、そこから何がほしいかを伝えてください。
Open-Meteo APIを使って、ホームページに、訪問者のいる都市の5日間の天気予報を表示してください。
AIがあまり知らないAPIの場合は、ドキュメントの必要な部分をチャットに貼りつけてください。たとえば、リクエストの例を1つと、その返事の例です。ドキュメントをファイルとして添付してもかまいません。くわしくは画像やファイルを添付するをご覧ください。
キーが必要なAPIを使う
カタログにないサービスのキーが機能に必要になると、AIがチャットにキーのカードを表示します。カードには、AIが使う名前(たとえば ACME_API_KEY)が書かれています。キーを貼りつけて 保存 をクリックしてください。キーなしで先に進みたいときは スキップ をクリックします。
カードにも書いてあるとおり、キーは暗号化されて安全に保存されます。チャットにもアプリのコードにも表示されません。あとから変更したいときは 管理 → シークレット で変えられます(チームメンバーの画面には、変更できるのはプロジェクトのオーナーだと表示されます)。
問い合わせフォームを追加して、送信されたらAPI経由でうちのCRMに新しいリードを作成してください。APIキーは私に聞いてください。
頼む前に、自分でキーを追加することもできます。管理 タブを開き、シークレット を選んで、新しいシークレットを追加 から追加してください。プレビューは変更を自動で取り込みます。公開済みのアプリには、次に公開したときに反映されます。くわしくはシークレットとAPIキーをご覧ください。
チャットのメッセージにキーを入力しないでください。チャットのメッセージはプロジェクトと一緒に保存されます。代わりに、キーのカードか 管理 → シークレット を使ってください。
自分だけのコネクタを作る
1つのサービスを複数のアプリで使う場合や、AIにAPIをしっかり理解してほしい場合は、自分だけのコネクタとして追加しましょう。APIの説明は一度書くだけです。そのあとは、カタログのコネクタと同じように使えます。キーで接続し、アプリごとにオン・オフを切り替えられ、AIはビルド中にそのコネクタを使ってビルドしたり、データを読んだりできます。
コネクタ のページで オリジナルのコネクタ までスクロールし、コネクタを作成 をクリックしてください。サービスのAPIドキュメントを開いておきましょう。APIのアドレスと、キーの渡し方が必要になります。説明そのものにキーを書く必要はありません。最後に、自分のキーで接続します。
詳細
名前 を付けます。カードに表示する 短い説明 と、できること も追加できます(どちらも任意です。できること は、AIがいつ使えばよいか判断する助けになります)。次に カテゴリ を選び、必要なら APIドキュメントのリンク を追加して、色 を選びます。コード名 は、アプリが読み取る設定名(たとえば
ACME_CRM_API_KEY)のもとになります。コード名はあとから変更できません。ログインの方法
すべてのリクエストの出発点になる APIのアドレス を入力します(
https://で始まる必要があります)。次に、サービスはどうやって本人確認をしますか? に答えます。選べるのは ベアラートークン、ヘッダーに入れるAPIキー、アドレスに入れるAPIキー、ユーザー名とパスワード です。アカウントIDなど、値が複数必要なサービスの場合は、2つ以上の値が必要ですか? の下に追加してください。リクエストのイメージ がプレビューで確認できます。テストリクエスト
読み取るだけで、キーが必要なリクエストを選びます。たとえば「自分は誰か」や「自分のアイテム一覧」のようなものです。Buildliyは、キーを保存する前にこのリクエストを実行して確認します。そのため、何も変更しないリクエストでなければいけません。試してみる(任意) にキーを貼りつけて テストを実行 をクリックすると、返事を確認できます。そのキーはテストにだけ使われ、あとでそのキーで接続しないかぎり保存されません。
データを見られる人
メールの受信箱、メモ、銀行など、個人のデータなら 自分だけ(個人用) を選びます。商品リストや公開されている情報など、みんなに向けたデータなら アプリを使う全員(共有) を選びます。
AIへのメモ
AIに知っておいてほしいAPIドキュメントの部分を貼りつけます。たとえば、エンドポイントや、リクエストと返事の例です(任意)。メモごとに ファイル名 を付け、必要なら AIはいつ読めばいいですか? も書いてください。メモは1つにつき2万文字まで、最大10個追加できます。AIは各メモの冒頭を見て、残りは必要になったときに読みます。ここにキーは絶対に貼らないでください。
コネクタを作成 をクリックします。続いて接続のウィンドウが開きます。試してみる(任意) にキーを入力していた場合は、そのキーがすでに入っています。必要ならキーを入力して 接続 をクリックしてください。Buildliyは、キーを保存する前にテストリクエストを実行して確認し、そのあと暗号化して保管します。キーは、アプリのサーバー側のコードでしか使われません。
私のAcme CRMコネクタを使って、ダッシュボードのページに最新の連絡先20件を表示してください。検索ボックスも付けてください。
自分だけのコネクタには、それぞれカードがあります。カードには 接続(接続後は 管理、キーが使えなくなったときは 再接続)、編集、削除ボタンが並んでいます。削除すると、コネクタと保存していたキーが消えます。そのコネクタを使っていたアプリは、もう一度追加するまでサービスにアクセスできなくなります。自分だけのコネクタは、最大25個まで作れます。
自分だけ(個人用) を選んだ場合、AIはそのサービスのデータを、アプリにログインした人だけが見られるようにします。接続したあと、アプリのコードがそのコネクタを使っていてログインがないと、公開前チェックリストが公開をブロックします。ログインがある場合は、あなた(またはあなたが選んだ人)だけがログインできるようにしてください、とチェックリストが知らせます。誰でも新規登録できる状態だと、誰にでもデータを見られてしまうからです。
サービスからイベントを受け取る
サービスによっては、新しい注文や支払いの完了など、何かが起きたときにアプリへメッセージを送ってくれます。こうしたメッセージは、よくウェブフックと呼ばれます。受け取り口をアプリに追加するよう、AIに頼んでみましょう。メッセージが本物かどうかを確かめるための署名シークレットをサービスが用意している場合は、AIがキーのカードでたずねます。
倉庫システムから新規注文のイベントを受け取るウェブフックのエンドポイントを追加して、注文ごとにデータベースへ保存してください。
サービスに伝えるのは、プレビューではなく、公開したアプリのアドレスにしてください。プレビューは常に動いているとはかぎらないためです。くわしくはアプリを公開するをご覧ください。