HTTP (OAuth2)
HTTP (OAuth2) は、OAuth 2.0認証に対応したAPIへ、任意のHTTPリクエストを送るためのアプリです。workrunに専用のアプリがないサービスでも、そのサービスがOAuth 2.0で保護されたAPIを公開していれば、連携できる場合があります。
- 接続を一度作成すれば、アクセストークンの取得・付与はworkrunが行います。フローの中でトークンを入力する必要はありません。
- 認証が不要なAPIや、APIキー・ベーシック認証・Bearerトークンで利用できるAPIは、HTTPアプリの「HTTPリクエストを送信」をご利用ください。
連携できるかどうかは、連携先サービスのOAuth 2.0の仕様によって異なります。接続に必要な値は、連携先サービスの開発者向けドキュメントをご確認ください。
HTTP (OAuth2) の接続方法
1. 連携先サービスでOAuthアプリを登録する
- 連携先サービスの開発者向け画面で、OAuthアプリ(クライアント)を作成します。
- 作成したアプリの Client ID と Client Secret を控えておきます。
- 「リダイレクトURL(コールバックURL)」の設定欄がある場合は、workrunの接続画面に表示されるリダイレクトURLを登録します。
- APIで利用したい機能に必要なスコープ(アクセス権限)を確認しておきます。
2. workrunで接続を作成する
- 接続から「接続を作成」をクリックし、HTTP (OAuth2) を選択します。
- 接続名を任意に設定します。接続先のサービス名を入れておくと、フローで選ぶときに区別しやすくなります。
3. 接続情報を入力する
連携先サービスのAPIドキュメントをもとに、次の項目を入力します。
| 項目 | 内容 |
|---|---|
| 認可方式(Grant Type) | 「Authorization Code」または「Client Credentials」を選びます。連携先のアカウントでログインして許可する方式は Authorization Code、ログインせずにアプリの資格情報だけでトークンを発行する方式は Client Credentials です。 |
| Authorize URL | ログインしてアクセスを許可する画面のURLです。 |
| トークンURL(Token URL) | アクセストークンを発行するURLです。 |
| Scopes | 利用するスコープを半角スペース区切りで入力します。 |
| Client ID / Client Secret | 手順1で控えた値を入力します。 |
4. 認証して保存する
- Authorization Code の場合は、連携先サービスのログイン・許可画面が表示されるので、アクセスを許可します。
- 「保存」を押して、接続が一覧に追加されたことを確認します。
接続できない場合
次のような場合は、HTTP (OAuth2) では接続できないことがあります。
- 連携先が、トークン発行時にworkrunと異なる方法でクライアント認証を求めている場合(Client Secretの送り方など)。連携先のアプリ設定で認証方式を変更できる場合は、変更することで接続できることがあります。
- 連携先の認証が、OAuth 2.0の標準とは異なる独自の手順やパラメータを必要とする場合。
- Authorization Code、Client Credentials 以外の認可方式(例:鍵ファイルを使って署名する方式)だけに対応している場合。