APIの基本を学べる対話型ハンズオンチュートリアル - n8n ワークフロー

n8n初心者: 外部APIとの連携方法を学ぶ必要がある、プラットフォーム初心者の方。
自動化エンジニア: チームメンバーにAPIの原則を教えるための、堅牢で分かりやすいn8nテンプレートを探している専門家。
学生・教育者: HTTPメソッドとAPIアーキテクチャに関する実践的かつ視覚的なガイドを必要としている方。
その他どなたでも: 実行にあたり外部認証情報が一切不要な、自己完結型のn8nワークフローをお探しの方。

あらゆる自動化スペシャリストにとって、API (Application Programming Interface) の習得は不可欠です。この強力なn8nワークフローは、自己完結型のAPIシミュレーション環境として機能します。API初心者が複雑な概念を5つの簡単な実行可能なレッスンに簡素化できる、最も効果的なn8nテンプレートの1つです。

ワークフロー全体でレストランのアナロジー（例え話）を採用しており、HTTP Request n8nノードを「お客様」、Webhook n8nノードを「キッチン」として扱います。このn8nワークフローを実行すると、5つの異なるAPIコールが即座に実行され、各n8nノードの入出力を調べることで、パラメータ、ヘッダー、ボディがレスポンスにどのように影響するかを確認できます。この対話型のアプローチにより即時フィードバックが得られ、実世界のAPIと連携する信頼性の高いn8nワークフロー自動化の構築方法への理解が深まります。

このn8nワークフロー全体は、手動のn8nトリガーによって開始され、直ちにすべて内部リクエストに必要なベースURLを計算します。

1. 準備 (ベースURL): Start Tutorial n8nトリガーがSet n8nノードを起動し、内部Webhookに必要なベースURLを動的に構築します。これにより、n8nワークフロー全体がテストモードでシームレスに動作することが保証されます。


2. レッスン1 (GETリクエスト): HTTP Request n8nノード（お客様）が、ターゲットのWebhook n8nノード（キッチン）からデータ（メニュー）を取得するためにシンプルなGETリクエストを送信します。


3. レッスン2 (クエリパラメータ): 2番目のHTTP Request n8nノードがGETリクエストを送信しますが、クエリパラメータ (?extra_cheese=true) を含めます。Webhook n8nノードはこれを受信し、IF n8nノードを使用して実行フローを分岐させ、オプションがリクエストをどのようにカスタマイズするかを示します。


4. レッスン3 (POSTリクエストとボディ): クライアントはPOSTリクエストを送信し、リクエストボディにデータ（お客様の声）を含めます。サーバー（別のWebhook n8nノード）はそのデータを処理し、Set n8nノードを使用して受信したコメントをレスポンスでエコーバックし、データ送信を例示します。


5. レッスン4 (ヘッダーと認証): クライアントは認証を必要とするリクエストを送信します。ヘッダーにx-api-keyを含めます。Webhook n8nノードはIF n8nノードを使用してこのキーをチェックします。キーが一致すればアクセスが許可され、一致しなければエラーレスポンスが返されます。


6. レッスン5 (タイムアウト処理): 最後のHTTP Request n8nノードは2秒のタイムアウトが設定されています。対応するWebhook n8nノードには3秒に設定されたWait n8nノードがあります。リクエストはタイムアウトにより失敗するように設計されており、堅牢なn8nワークフローにおける重要なエラーハンドリングロジックを浮き彫りにします。

この教育用n8nワークフローテンプレートを使用するには、次の簡単な手順に従ってください。

1. JSONのインポート: 提供されているJSONデータをコピーします。


2. お使いのn8nインスタンスで、「新規作成」→「JSONからインポート」をクリックし、コピーしたデータを貼り付けます。


3. 認証情報は不要: このn8nワークフローは自己完結型であり、内部Webhookアドレスを使用するため、外部の認証情報やAPIキーは必要ありません。


4. チュートリアルの実行: 右上の「ワークフロー実行」ボタンをクリックして、開始トリガーからn8nワークフロー全体を実行します。データが流れる様子を確認するために、「お客様」（HTTP Request n8nノード）と「キッチン」（Webhook n8nノード）の各ペアの出力を確認してください。

このチュートリアルでは、完全なAPI通信をシミュレートするために、いくつかの主要なn8nノードタイプを利用しています。

手動トリガー (Start Tutorial): ワークフローの実行を手動で開始するために使用される、開始トリガー。
Set (ベースURL設定、メニューの返信など): Webhook呼び出しに必要なベースURLを動的に計算したり、「キッチン」が「お客様」に返す特定のJSONレスポンスを作成したりするために広範に使用されます。
Webhook n8nノード (キッチン): シミュレートされたAPIサーバーとして機能します。HTTP Request n8nノードからの着信リクエストをリッスンするために、特定のパス (/menu、/order、/reviewなど) およびHTTPメソッド (GET、POST) で設定されています。
HTTP Request n8nノード (お客様): APIクライアントとして機能し、呼び出しを開始します。これはシミュレーションの中心となるn8nノードであり、クエリパラメータの送信、ボディを伴うPOSTメソッドの使用、カスタムヘッダーの追加、リクエストタイムアウトの設定など、特定のAPI機能を実証するように設定されています。
IF n8nノード (チーズ追加の判定、認証判定): Webhook n8nノードが受信した入力に基づいてフロー制御を提供します。特定のパラメータ（例：クエリパラメータやヘッダー値）をチェックし、それに応じてレスポンスを振り分けます。
Wait n8nノード (3秒待機): レッスン5で使用され、APIの応答が遅い状況をシミュレートします。このn8nノードはサーバーの応答を意図的に遅らせ (3秒)、クライアント側のHTTP Request n8nノードがタイムアウト (2秒) するようにし、複雑なn8nワークフローにおける堅牢なタイムアウト処理を実証します。