ProtoPie ConnectでAPIプラグインを使用する

プロとエンタープライズ料金制の両方に対応しています。

APIプラグインを使用すると、実際のデータをAPIとデータベースに接続して、迅速にプロトタイプに取り込むことができます。ユーザー指定プラグインとは違い、APIプラグインの使用にはコーディングスキルが必要ありません。このプラグインはデータをAPIに送信する作業や、データをAPIで検索してJSON形式でプロトタイプにスムーズに統合する作業に関与します。

APIとは何ですか？

API(Application Programming Interface：アプリケーションプログラミングインターフェース)とは、それぞれ異なるコンピュータプログラムが通信して一緒に作動するようにする一連のルールのことです。これは、それぞれのプログラムが作動する方式の全ての細部情報を知らなくても情報を共有し、作業できるようにする橋梁の役目を果たします。つまり、APIを使用すると、ソフトウェアが通信して協業するのがもっと楽になります。

対応するAPIタイプ

APIプラグインを使用すると、GETであれPOSTであれAPIリクエストを素早く開始し、様々なAPIタイプと接続できます。

公開API: これには、SpotifyやOpenWeatherMap、YouTube、ChatGPT、Live Scoresなどのような人気のあるサービスが含まれます。
内部API: 組織のシステムとサービスに円滑に接続できます。

APIリクエストの作成方法

ProtoPie ConnectでAPIプラグインを使用してプロトタイプでAPIリクエストを作成するには、以下のような簡単な手順に従ってください。

手順1：ProtoPie Studioで送信(Send)レスポンスを作成する

ProtoPie Studioで送信(Send)レスポンスを選択したトリガーに追加して開始します。
ProtoPie StudioとProtoPie Connect間で情報をやり取りする場合、一般的に行うように ProtoPie Connect/Studio チャンネルを選択することを忘れないようにします。
プロトタイプを保存します。

このプロトタイプ例では、トグルスイッチを使って「Random Fact」を選択する際に、Useless Facts APIからデータを取得しようとしています。この作業を行うために、 ProtoPie Connect/Studio チャンネルと固有メッセージ値を使って送信(Send)レスポンスを作成します。

ProtoPie StudioとProtoPie Connect間のメッセージ送信と受信をマスターするには、ProtoPieスクールの無料レッスンを確認してください。

手順2：APIプラグイン内でAPI設定を構成する

ProtoPie Connectでプロトタイプを開きます。
プラグインをクリックしてから、リストでAPIプラグインを選択します。
使用可能な二つのHTTPリクエスト方法(GET又はPOST)のうち一つを選択します。APIリクエストを作成する際、GETはAPIプロバイダーからデータを取得する一方で、POSTは処理する新しいデータを送信します。
アクセスしようとするAPIの正しいAPI URLを入力します。有効なURL取得には、APIのオンライン文書をご参照ください。この例では、必要なURLが https://uselessfacts.jsph.pl/api/v2/facts/randomであることをこのページで確認できます。
APIで必要とする場合、 Header と Body を含みます。API URLと共に必要な追加パラメータを確認するには、選択したAPIの文書を注意深く読んでください
Test Request ボタンをクリックして、接続が正しく作動しているか確認します。エラーメッセージが表示された場合、前の手順で入力した情報を検討してください。

手順3：APIをプロトタイプと接続する

Message From Pie 入力フィールドをクリックして、使用可能なメッセージリストにアクセスします。APIプラグインはプロトタイプ内のメッセージを自動的に検出します。メッセージが表示されなければ、手順1で作成した送信(Send)レスポンスからコピペします。
プロトタイプによって送信されたメッセージの値でAPIのURL、Header、Bodyを動的にオーバーライドする必要がある場合は、 Override URL/Header/Body with msg value を活性化します。メッセージ値でAPI URL、Header、Bodyをオーバーライドするについての詳細をご覧ください。
Message to Pieにメッセージを入力します。入力したメッセージは、手順2で構成したAPIリクエストから取得したデータと共にプロトタイプに送り返されます。
Activate をクリックして接続を設定します。プロトタイプから当該メッセージを受信すると、プラグインがAPIリクエストを開始します。

手順4：ProtoPie Studioで受信(Receive)トリガーを作成する

ProtoPie Studioに戻ります。
プロトタイプに受信(Receive)トリガーを追加します。
手順1で送信(Send)レスポンスを設定した際と同様に、 ProtoPie Connect/Studio チャンネルを選択することを忘れないでください。
手順3で構成したのと同じメッセージを Message to Pieに入力します。
Assign to Variable オプションを活性化します。テキスト変数を作成して受信(Receive)トリガーリストで選択します。APIから取得した情報はこの変数に保存されます。
APIデータはJSON形式で返されることがよくあるため、parseJson数式でテキスト(Text)レスポンスを使用してAPIデータをプロトタイプに統合するのが最も効率的です。
プロトタイプを保存してから、ProtoPie Connectでリロードします。これで、ProtoPie Connectを通じてAPI基盤の相互作用をテストする用意ができました！

メッセージ値でAPI URL/Header/Bodyをオーバーライドする

Override URL/Header/Body with msg value は、プロトタイプから送信されたメッセージの値でAPIのURL、Header、Bodyパラメータを動的にオーバーライドするのに使用されます。

このプロトタイプ例では、この機能を使用してPieファイル内の以下の送信(Send)メッセージの値でAPI URLをオーバーライドしました。結果的に、ProtoPie Connectでプロトタイプをテストして検索ボックスに都市名を入力すると、その都市の正確な気象情報が表示されます。

同時API呼び出し(エンタープライズ専用)を実行する

エンタープライズ料金制を使用しているチームは、APIプラグインで同時に複数のAPIリクエストを実行できます。それによって、同時に複数のAPIとプロトタイプを接続できるようになり、柔軟性と利便性がさらに高まります。

プロトタイプで同時に複数のAPIリクエストを実行するには、次の手順に従ってください。

ProtoPie ConnectでAPIプラグインを開きます。
API設定画面の右上のコーナーにある + アイコンをクリックします。このようにすると新しい画面が開きますが、その画面で追加API呼び出しを構成して同時に実行できます。従来のAPIを複写して本来の設定を維持することもできます。

APIプラグイの入門チュートリアル

この入門書シリーズでAPIプラグインの主な機能と使用例をご確認ください。