Java で Google API との接続を確立する方法

1. 始める前に

前提条件

実装プロセスのステップ 1 と 2 を完了している。
Google を使用して構成したドメインで Google App Engine または独自のソリューションを使用することにより、提供されている Java サーバーと TLS 終端をホストすることが可能である。
Java が環境にインストールされている。

学習内容

Google echo API への有効なリクエストを行って接続を確認する方法。
Google から Partner Hosted echo API へのリクエストを受信、復号、解析する方法。

2. 設定と要件

アプリケーションをダウンロードする

Java サンプルコードをダウンロードします。

アプリケーション構造の概要

Java のサンプルコードは、Google の Standard Payments API と統合されています。サンプルコードプロジェクトの構造には、Google からパートナーへのインバウンドエコーリクエストと、パートナーの実装から Google へのアウトバウンドリクエストを反映する outbound ディレクトリと inbound ディレクトリが含まれています。

これらのディレクトリには、レイヤごとのパッケージングで同様の階層が含まれています。主なレイヤは controller、service、domain の 3 つです。

controller パッケージには API が含まれています。
service パッケージは、ビジネスロジック、base64url エンコード、暗号化を担当します。
domain パッケージには POJO が含まれています。

依存関係のインストール

プロジェクトディレクトリに移動し、次のコマンドを実行して Maven ラッパーを使用して必要な依存関係をインストールします。App Engine を使用している場合は、この手順を省略できます。

./mvnw install

3. 決済インテグレーターアカウント ID（PIAID）を構成する

決済インテグレーターアカウント ID（PIAID）は、統合を一意に識別するために使用される ID です。このチュートリアルを開始する前に前提条件を満たしていれば、Google から PIAID が届いているはずです。

プロジェクトディレクトリの src/main/resources/application.properties に移動します。
プロパティ payment.integrator.account.id に、Google から発行された PIAID を設定します。

payment.integrator.account.id={YOUR_PAYMENT_INTEGRATOR_ACCOUNT_ID}

4. Google ホスト型エコー URL を設定する

Google ホストの echo URL は、統合する API によって異なります。特定の統合タイプの API リファレンスドキュメントにアクセスし、診断エコー API の URL をコピーします。URL をコピーしたら、次の手順に進んで Java プロジェクトで URL を更新します。

プロジェクトディレクトリの src/main/resources/application.properties に移動します。
プロパティ API_SERVICE_NAME を、デベロッパー向けドキュメントに記載されているものと一致するように設定します。

google.hosted.echo.url=vgw.googleapis.com/gsp/{API_SERVICE_NAME}/echo/

5. PGP 鍵を追加する

以下に示すように、PGP 鍵を追加して PGP 暗号化を有効にします。

src/resources/publicKey1.gpg に移動し、ASCII Armour 形式の公開鍵をファイルに追加します。
src/resources/privateKey1.gpg に移動し、ASCII Armour 形式の秘密鍵をファイルに追加します。
src/resources/passphrase1.txt に移動し、このファイルにシークレットパスフレーズを追加します。

PGP 鍵の追加

デュアルキー暗号化を有効にするには、2 つ目の公開鍵を publicKey2.gpg に追加し、2 つ目の秘密鍵を privateKey2.gpg に追加し、2 つ目のパスフレーズを passphrase.txt に追加します。2 つ目の鍵を追加したら、KeyConfig.addPrivateKeyAndPassphrase(...) と KeyConfig.addPublicKeys(...) で 2 つ目の鍵のペアの読み込みを担当するコメントアウトされたコード行のコメントを解除します。

これでアプリケーションを実行する準備が整いました。

6. アプリケーションを実行する

次のコマンドを実行して、アプリケーションを開始します。

  $ ./mvnw spring-boot:run

事前構成済みの App Engine インスタンスを実行している場合は、代わりに次のコマンドを実行します。

$ gcloud app deploy

デフォルトでは、サーバーはポート 8080 をリッスンします。Open API Swagger UI を表示するには、次の URL に移動します。

https://{APPLICATION_HOST}/swagger-ui.html

7. Google Standard Payments Outbound API の接続をテストする

アプリケーションが実行状態になったら、Google echo API との接続のテストに取りかかります。

Swagger UI または CLI のいずれかを使用して、次のコマンドを実行し、サンプルアプリケーションのインスタンスから Google のサーバーへの呼び出しを開始します。サンプルアプリケーションの echo API は、平文の POST リクエストを受け付けます。リクエストを受信すると、以降のリクエストは Google がホストする API に送信されます。

コマンドラインからリクエストを送信する

コマンドを実行する前に、HOSTNAME をサーバーホストの名前に置き換えます。

  $ curl -X POST -H 'Content-Type: text/plain' -d 'Hello from Partner Bank!' https://{HOSTNAME}/echo

Swagger UI でリクエストを送信する

Swagger UI でリクエストを送信するには、https://{APPLICATION_HOST}/swagger-ui に移動し、リクエスト本文でクライアントメッセージを設定します。リクエストを Google に送信する準備ができたら、[実行] ボタンをクリックします。

Swagger を使用して GSP Echo リクエストを送信する

レスポンスを受信する

API リクエストが正常に処理されると、Google から次のレスポンスが返されます。

{
   "responseHeader":{
      "responseTimestamp":"1606710026723"
   },
   "clientMessage":"Hello from  Bank Little Bear!",
   "serverMessage":"Server message."
}

詳細な手順

リクエストがサーバーによって正常に送信されたら、これからはその動作について詳しく見ていきます。

リクエストを作成する

OutboundEchoService の createEchoRequestWithMessage により、Google の API に送信される echo リクエストが作成されます。

String jsonEchoRequestMessage = objectMapper.writeValueAsString(createEchoRequestWithMessage(message));

生成されるリクエストには、clientMessage のほか、複数のデフォルト値のフィールドが含まれます。

{
   "requestHeader":{
      "protocolVersion":{
         "major":1,
         "minor":0,
         "revision":0
      },
      "requestId":"ddfe0fd0-ffdc-4fcf-991a-f0611ec83970",
      "requestTimestamp":"1606715389040"
   },
   "clientMessage":"Hello from Bank Little Bear!"
}

リクエストを Base64url でエンコードして暗号化する

すべてのリクエストは暗号化され、base64url でエンコードされます。このサンプルの PgpEncryptor.java には、暗号化と復号、base64url エンコードを行うヘルパーメソッドが含まれています。以下のメソッドは、リクエストをエンコードし、Google の公開鍵を使用して暗号化を行います。

String encryptedMessage = pgpEncryptor.encrypt(jsonEchoRequestMessage);

POST リクエストを送信する

暗号化されたメッセージは POST リクエストで送信されます。

postStandardPaymentsEchoApi(encryptedMessage)

レスポンスを復号して base64url でデコードし、レスポンスを返す

Google の正常なレスポンスは base64url でエンコードされ、暗号化されているため、平文で返す前にデコードと復号を行う必要があります。decrypt メソッドは、レスポンスを base64url でデコードして復号します。

String decryptedData =
     pgpEncryptor.decrypt(postStandardPaymentsEchoApi(encryptedMessage).getBody());

レスポンスを返す

レスポンスは 202 HTTP レスポンスステータスコードで返されます。

return new ResponseEntity<>(decryptedData, HttpStatus.ACCEPTED);

8. インバウンド API の接続をテストする

インバウンド echo API 接続をテストするために、Google はパートナーホスト echo API にリクエストを送信します。準備ができたら、Google の担当者と連携して、このリクエストを Google からトリガーしてください。

Google からの受信 echo リクエストを読み取り、有効な echo レスポンスを返すことができるようになったら、echo テストは完了となります。

詳細な手順

リクエストがサーバーによって正常に受信され処理されたら、これからはその動作について詳しく見ていきます。

リクエストを Base64url でデコードして復号する

リクエストを受信すると、PgpEncryptor.java が decrypt を呼び出し、リクエストを base64url でデコードして復号します。

String decryptedRequest = pgpEncryptor.decrypt(echoRequest);

リクエストを受信する

デコードと復号が完了した後に、Google は次のようなメッセージペイロードを送信しました。

{
  "requestHeader": {
    "protocolVersion": {
      "major": 1
    },
    "requestId": "G1MQ0YERJ0Q7LPM",
    "requestTimestamp": {
      "epochMillis":1481899949606
    },
    "paymentIntegratorAccountId": "abcdef123456"
  },
  "clientMessage": "echo Me"
}

レスポンスを作成する

受信 echo リクエストを正常に読み込めたら、レスポンスを作成する準備ができています。

private EchoResponse convertEchoRequestStringToEchoResponse(String decryptedRequest);

レスポンスには、Google からのメッセージのほか、サーバーのタイムスタンプとメッセージも含まれます。

{
  "responseHeader": {
    "responseTimestamp": {
      "epochMillis":1481899950236
    }
  },
  "clientMessage": "echo Me",
  "serverMessage": "Debug ID 12345"
}

レスポンスを base64url でエンコードして暗号化する

すべてのリクエストは暗号化され、base64url でエンコードされるため、PgpEncryptor.java は encrypt を呼び出してリクエストを base64url でエンコードして暗号化します。

pgpEncryptor.encrypt(echoResponseString)

レスポンスを返す

レスポンスは 202 HTTP レスポンスステータスコードで返されます。

return new ResponseEntity<>(pgpEncryptor.encrypt(echoResponseString), HttpStatus.ACCEPTED);

9. 完了

この Codelab では、Payments API との接続を正常に確立しました。

Java で Google API との接続を確立する方法 コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

1. 始める前に

前提条件

学習内容

2. 設定と要件

アプリケーションをダウンロードする

アプリケーション構造の概要

依存関係のインストール

3. 決済インテグレーター アカウント ID（PIAID）を構成する

4. Google ホスト型エコー URL を設定する

5. PGP 鍵を追加する

6. アプリケーションを実行する

7. Google Standard Payments Outbound API の接続をテストする

コマンドラインからリクエストを送信する

Swagger UI でリクエストを送信する

レスポンスを受信する

詳細な手順

リクエストを作成する

リクエストを Base64url でエンコードして暗号化する

POST リクエストを送信する

レスポンスを復号して base64url でデコードし、レスポンスを返す

レスポンスを返す

8. インバウンド API の接続をテストする

詳細な手順

リクエストを Base64url でデコードして復号する

リクエストを受信する

レスポンスを作成する

レスポンスを base64url でエンコードして暗号化する

レスポンスを返す

9. 完了

Java で Google API との接続を確立する方法

3. 決済インテグレーターアカウント ID（PIAID）を構成する