Web API
コネクタとは
Web API コネクタとは
Web API コネクタとは、WebAPIを提供する外部のサービスとノーコードで連携できる機能です。
通常、Web API と連携するにはプログラミングが必要ですが、Web API コネクタを利用することで、専門知識がないユーザーでも GUI 上で簡単に連携設定を行えます。
Web API コネクタは、Web API のエンドポイント、メソッド、ヘッダ、リクエストパラメータ、レスポンス形式などを定義することで、外部サービスとのWeb API との連携を確立できます。
エンドポイントとは
Web API のエンドポイントとは、 Web API サーバーにアクセスするための特定の URL(Uniform Resource Locator)のことです。
WebAPIにアクセスするための「入り口」のようなものです。
例えば、以下のようなエンドポイントが考えられます。
このエンドポイントは、example.com というドメインの Web API サーバにある users というリソースにアクセスするためのものです。
メソッドとは
メソッドとは、 対象のデータに対してどのような操作を要求するかを示すためのものです。
Web APIでは、これらのメソッドを使って、データに対する操作を指定します。
-
GET
対象のデータを取得します。
-
POST
対象のデータを追加または更新します。
-
PUT
対象のデータを更新します。追加と更新を区別しない場合は、POSTで代用できます。
-
DELETE
対象のデータを削除します。
ヘッダとは
WebAPIのヘッダは、主にAPIキーやトークンを用いた認証のために使用されます。
例えば、以下のような例が考えられます。
リクエストパラメータとは
WebAPIのリクエストパラメータは、対象のデータを条件を指定して操作するために使用されます。
例えば、以下のような例が考えられます。
「ユーザ」という対象のデータに対して、名前がジョン、年齢が30歳のデータを指定して取得します。
ボディパラメータとは
WebAPIのボディパラメータとは、対象のデータを取得した時に情報を格納するために使用されます。
現在は、JSON形式で取得するのが一般的です。
"name": "John",
"age": 30
}
Web API コネクタのメリット
-
Merit01
開発工数の削減
プログラミングが不要になるため、開発工数を大幅に削減できます。
-
Merit02
専門知識不要
API に関する専門知識がないユーザーでも、GUI 上で簡単に連携設定を行えます。
-
Merit03
柔軟な連携
様々な Web API と柔軟に連携できるため、ビジネスニーズに合わせたシステム構築が可能です。
Web API コネクタは、以下の項目を定義することで、外部サービスとのWeb API との連携を確立できます。
外部サービスは、一般的にWebAPI仕様書として、WebAPIのパラメータに関する資料が提供します。
こらを参照し、適切な設定をすることで、WebAPIによる業務効率化が期待できます。
・メソッド
・ヘッダ
・リクエストパラメータ
・ボディパラメータ
関連項目:Web API と業務効率化