「API連携ブロック」を使用すると、外部システム（CRM、在庫管理システム、スプレッドシート等）との間でデータを送受信できます。
■ 利用条件
対象プラン： PROプラン、旧プラン（スタンダード・フリー）
■ 基本設定
接続先のサーバー情報を正しく指定します。
| 項目名 | 内容・設定詳細 |
|---|---|
| ブロック名 | 管理画面上の名前です。内容がわかる名前（例：顧客データ送信）を付けます。 |
| メソッド | GET: データの取得 / POST: データの登録 / PUT: 更新 / DELETE: 削除 |
| URL |
APIの接続先URLです。末尾にパラメータ（?id=#{id}など）を含めることも可能です。
|
| 情報参照名 |
相手から返ってきたデータに付ける「箱の名前」（変数）です。 取得したデータを後で使う際に必要になります。 |
【画像：基本設定の画面イメージ】
■ 詳細設定
通信のルールや認証情報を細かく指定します。
1. ヘッダ（Header）の設定
相手のシステムに「誰がアクセスしているか」「どんなデータ形式か」を伝える重要な場所です。
① 認証： 標準的な認証（Authorization）を1行で書く欄です。
Bearer [APIキー]のように入力すると、システムが自動で認証ヘッダとして処理します。-
② キー / ③ 値： API連携を行う上で必要なヘッダークエリを1つずつペアで登録します。
例：キーに
Content-Type、値にapplication/jsonと入力。システム独自のキーが必要な場合もここに追加します。
2. ボディタイプ（Body Type）
送信するデータの形式を選びます。
None： 送るデータ本体がない場合（主にURLだけで完結するGETメソッドなど）。
json： データを整理された構造で送る形式です。今のAPIの主流です。
form-data： 複数の項目やファイルを「バラバラのパーツ」として送る形式です。
x-www-form-urlencoded： フォーム入力のように「キー=値&キー=値」と繋げて送る形式です。
3. タイムアウト
内容： 相手のサーバーからの返事をどれくらいの時間（秒）待つか。
目安： 連携先のシステムや行う処理により異なります。
注意： 短すぎると処理が終わる前に「失敗」と見なされ、長すぎるとシステム全体の動作が重く感じられます。
【画像：詳細設定の画面イメージ】
■ シナリオ動作確認
設定した内容で実際に1回通信を試し、実際の会話シーンでの動きをシミュレーションします。
【画像：シナリオ動作確認（シミュレーター形式）の画面イメージ】
-
(Requests : ○○)：
APIに送信されたデータの実際の値です。
ここが空の場合、手前のブロックで変数（#{ }）が正しく取得できていない可能性があります。 -
API連携 return { ... }：
相手のシステムから返ってきた生のデータです。
この中身を見て、正しく連携できているか、どの項目を取り出すかを確認します。 -
判定：
意図した結果であれば「成功」を押して保存します。
エラーやデータ不備があれば「失敗」を押し、設定を見直してください。
■ JSON（ジェイソン）ボディの書き方
jsonは書き方（構造）に非常に厳密です。
1. 記述例
以下の内容をコピーして、"user_name"や、#{ } の中身を自分の変数名に変えて利用することも可能です。
JSON
{
"user_name": "#{user_name}",
"tel_number": "#{InboundPhoneNumber}",
"status": "active"
}
2. 省いてはいけない4つの項目
{ }（波括弧）： 最初と最後に必ず1つずつ。データの「開始」と「終了」です。" "（二重引用符）： 項目名も内容もすべてこれで囲みます。※数値やtrue/false以外:（コロン）： 項目名と内容の間に必ず入れます（半角）。-
,（カンマ）： 項目が2つ以上あるとき、「次の項目があるよ」という合図です。注意！：一番最後の項目の後ろにはカンマを絶対に入れないでください。
■ こんな時は！よくあるトラブル解決（FAQ）
Q. 「シナリオ動作確認」でエラーが出る
A. 全角文字が混じっていませんか？
JSON欄で、コロン
:やカンマ,、二重引用符"が全角になっていると、コンピュータは理解できずエラーになります。
必ず半角英数で入力してください。
Q. 変数を送ったのに、中身が空っぽで届く
A. 変数名の綴り（スペル）を確認してください。
情報参照名の大文字・小文字が1文字でも違うと、システムは別の情報参照名として扱います。
そのような場合、存在しない情報参照名を送ることになり、 (Requests : ) の中身が空となります。
■ 実行結果のデータの使い方
相手から返ってきたデータは「情報参照名」を使って取り出します。
設定例： 情報参照名を
resとした場合確認方法： シナリオ動作確認の
return { "status": "ok" }の中身を見る。呼び出し方：
#{res.status}と書くことで、"ok" という文字がシナリオ内で使えます。
■ 参考シナリオ（kintone API 連携）
下記シナリオをミライAIにインポートしていただくことで、API連携時のシナリオをご確認いただけます。
【PROプラン限定】kintone 在庫数自動確認（API実演用）
製品番号をヒアリングし、該当の製品の在庫が存在するかどうかを回答します。
📁 連携先のkintoneアプリ
上記ファイルをダウンロード後、kintoneへ取り込むことでアプリを再現可能です。
📷 【画像：kintone製品マスタ（在庫管理パック）のアプリ画面イメージ】
⚠️ 【注意】 実際にkintoneと連携を行う際は、APIトークン、サブドメインはご自身のものに変更しご利用ください。