Skip to content

README.md

Latest commit

 

History

History
211 lines (164 loc) · 12.3 KB

README.md

File metadata and controls

211 lines (164 loc) · 12.3 KB
Raw

Partner API SDK for Java

Getting started

Partner APIとの通信はPartnerAPIクラスを通じて行います。

PartnerAPI client = new PartnerAPI(new File("./config.properties"));

設定はINI形式のファイルに記述し、PartnerAPIのコンストラクタに指定します。

SDKプロジェクトルートのsample.propertiesというファイルがありますので、それを元に必要な情報を記述してください。
特に以下の情報は通信の安全性のため必要な項目です。これらはパートナー契約時にお渡ししているものです。

  • CLIENT_ID: パートナーAPI クライアントID
  • CLIENT_SECRET: パートナーAPI クライアント秘密鍵
  • SSL_KEY_FILE: SSL秘密鍵ファイルパス
  • SSL_CERT_FILE: SSL証明書ファイルパス

また、この設定ファイルには認証に必要な情報が含まれるため、ファイルの管理・取り扱いに十分注意してください。

Overview

APIリクエスト

Partner APIとの通信はリクエストオブジェクトを作り、PartnerAPI#sendメソッドに渡すことで行われます。

  • PartnerAPI#send(request): リクエストを送信します。返り値はリクエストに応じた型にキャストする必要があります。

リクエストクラスはjp.pokepay.partnerapi.request以下に定義されます。

例として、送信した内容をそのまま返すSendEchoを下記に記します。

Request request = new SendEcho("hello");
Echo echo = (Echo) client.send(request);
System.out.println(echo.getStatus()); // => "ok"
System.out.println(echo.getMessage()); // => "hello"

リクエストパラメータには必須パラメータと省略可能パラメータが存在します。 必須パラメータはリクエストクラスのインスタンス引数として渡し、省略可能パラメータはリクエストクラスのメソッドを用いて渡します。

Request request = new CreateHoge("xxx")
    .param1(100)
    .param2("aa");

上記の例ではCreateHoge引数の"xxx"が必須パラメータでありparam1とparam2メソッドで設定した値が省略可能パラメータです。

利用可能なAPIについてはAPI Operations で紹介します。

エラーレスポンス

このSDKでは3種類のExceptionが存在します。

SSLInitializeError

SSLの初期化に関するエラーに使われます

ProcessingError

設定ファイルが存在しない場合や設定ファイルの内容に不備があるなど、一般的なプログラムに関するエラーに使われます。

PartnerRequestError

APIサーバがエラーレスポンスを返した場合に使われます。

Methods

  • getType() string: エラーレスポンスの種類を表す文字列を返します。

  • getMessage() string: エラーレスポンスの種類に対応するメッセージを文字列で返します。

  • getRawJson() string: エラーレスポンスを表すjsonを文字列で返します。

API Operations

Transaction

Transfer

Check

Bill

Cashtray

Customer

CreditSession

CVS

Organization

Shop

User

Account

  • ListUserAccounts: エンドユーザー、店舗ユーザーのウォレット一覧を表示する
  • CreateUserAccount: エンドユーザーのウォレットを作成する

Private Money

Bulk

Event

Campaign

Webhook

Coupon

UserDevice

BankPay

SevenBankATMSession