HTTP API

HTTP API のデータソースに接続する

1. 右上のメニューから「データソース」を選択する

2. 「データソースの追加」をクリックする

3. データソースの種類の中から「HTTP API」を選択する

4. データソースへの接続に必要な情報を入力して保存する

アクション実行時に自動的に付与される共通ヘッダーの設定を行なうことができます。

すべてのアクションに同じヘッダーの設定を行なう必要があるようなケースでご利用いただけます。

共通ヘッダーでは、変数・シークレットをご利用いただくことができます。環境に応じて共通ヘッダーの内容を変えたい場合や、秘匿情報を含めたい場合にご利用ください。

書式については変数・シークレットの使用方法をご覧ください。

HTTP APIアクションでは、認証形式としてBasic認証と、認証用アクションのいずれかを選択できます。

Basic認証を使用するには、認証形式としてBasic認証を指定したうえで、ユーザー名・パスワードを入力します。

認証用アクションを設定すると、アクションの実行前に別のアクションを実行し、その結果を任意のHTTPヘッダーに設定できます。

例えば、事前にアクセストークンを取得するためのアクションを実行し、結果から取得したトークンを共通のHTTPヘッダーとして使えます。

アクションの実行結果は、HTTPヘッダーに設定したい文字列を return するJavaScriptコードを記述することで処理します。

このJavaScriptコードの書き方はアクションの結果表示のカスタマイズと共通しているので、アクションの実行ページで事前に動作内容を確認できます。

1. 右上のメニューから「アクション」を選択する

2. 「アクションの追加」をクリックする

3. アクション名やパラメーターを設定する

APIに対してのリクエスト内容を入力してください。

上記の例はURLのパスパラメーターとして値を利用しています。

他にもヘッダーやクエリパラメーター、リクエストボディの中に3で指定したパラメーターを渡すことができます。

HTTP APIのアクションでは、GraphQLサーバーとの通信に使いやすくするため、リクエストタイプに GraphQL を用意しています。

GraphQL を選択すると、QueryとVariablesを入力するフィールドがそれぞれ表示されます。

GraphQLサーバーへのリクエストは、上記フィールドへの設定内容をもとにJSON形式で送信されます。

Query、Variablesのいずれも、他のリクエストタイプと同様に、パラメーターを渡すことができます。上記の例では、Variablesの id キーに、 "{{ id }}" としてパラメーターを渡しています。