OAuth2 for Apps Scriptライブラリはどうやって認証用URLを作成しているのか

photo credit: Wojtek Gurak Linked Hybrid via photopin (license)

みなさん、こんにちは！
タカハシ(@ntakahashi0505)です。

GASによるマネーフォワードクラウド請求書APIの操作についてできる限りていねいに紹介をするシリーズをお送りしています。

前回の記事はこちら！

OAuth2 for Apps Scriptライブラリを使ってサービスを作るスクリプトを解説

GASによるマネーフォワードクラウド請求書APIの操作についてできる限りていねいに紹介をするシリーズです。今回は、OAuth2 for Apps Scriptライブラリを使ってサービスを作るスクリプトを解説します。

OAuth2ライブラリでマネーフォワードクラウド請求書API用の「サービス」を作るスクリプトを解説しました。

今回は、その続き。

OAuth2 for Apps Scriptライブラリがどうやって認証用URLを作成しているのかを解説します。

では、行ってみましょう！

前回までのおさらい
マネーフォワードクラウド請求書URLの認証用URL
1. 認証用URLを取得する
2. 認証用URLのつくり
まとめ
連載目次：【初心者向け】GASでマネーフォワード請求書API

前回までのおさらい

前々回の記事では、OAuth2ライブラリでマネーフォワードクラウド請求書APIへの認証を行い、アクセストークンを取得する流れをざっと説明しました。

まず、以下のauthorize関数を実行するんでしたね。

/**
 * 認証を行いアクセストークンをログ出力する
 */
function authorize() {
  const service = getMFInvoiceService_();
  const authorizationUrl = service.getAuthorizationUrl();
  console.log(authorizationUrl);
}

すると、getMFInvoiceService_関数が呼び出されて、マネーフォワードクラウド請求書API用の「サービス」が作成されます。

/**
 * 指定した名前で新しいMFクラウド請求書のサービスを作成する
 */
function getMFInvoiceService_() {
  
  const serviceName = 'mfInvoice';
  const authorizationBaseUrl = 'https://invoice.moneyforward.com/oauth/authorize';
  const tokenUrl = 'https://invoice.moneyforward.com/oauth/token';
  
  const properties = PropertiesService.getScriptProperties();
  const clientId = properties.getProperty('CLIENT_ID');
  const clientSecret = properties.getProperty('CLIENT_SECRET');
  
  return OAuth2.createService(serviceName) 
      .setAuthorizationBaseUrl(authorizationBaseUrl)
      .setTokenUrl(tokenUrl)
      .setClientId(clientId)
      .setClientSecret(clientSecret)  
      .setCallbackFunction('authCallback_')
      .setPropertyStore(PropertiesService.getUserProperties())
      .setScope('write');
}

前回は、このgetMFInvoiceService_関数の解説をしました。

今日は、そのサービスが作成された後に行われている、認証URLの作成とそのつくりについて解説を続けます。

マネーフォワードクラウド請求書URLの認証用URL

認証用URLを取得する

サービスを作成された後、authorize関数でいうと6行目が実行されます。

getAuthorizationUrlメソッドは、その名の通り、認証用URLを取得するメソッドです。

OAuth2Serviceオブジェクト.getAuthorizationUrl()

これで取得した長ーい認証用URLをログ出力したのが以下の画面です。

これをブラウザで入力すると、マネーフォワードクラウド請求書APIの認証画面に遷移しましたよね。

認証用URLのつくり

さて、この認証用URLのつくりが、どのようになっているか見てみましょう。

ログ出力されたURLを見ると、つくりとしては、以下のようになっていることがわかります。

https://invoice.moneyforward.com/oauth/authorize?client_id=[client_id]&response_type=code&redirect_uri=[redirect_url]&state=[state]&scope=[scope]

分解すると、以下のパーツにわけられます。

項目	値
認証用ベースURL	https://invoice.moneyforward.com/oauth/authorize
client_id	アプリケーション作成時に発行されたclient_id
response_type	code
redirect_uri	リダイレクトURL（アプリケーション作成時に入力したものと同じ）
state	stateパラメーター
scope	write