ライブラリ

WebPayのAPIを利用する際や、クライアントサイドでのインタフェースを構築する際などに役立つ 各プログラミング言語向けのライブラリを開発、配布しています。

サーバサイド向け
クライアントサイド向け

サーバサイド向け

サーバサイド向けのライブラリについては、各言語向けのライブラリ配布用の仕組みおよび、本ページよりzipにてダウンロードすることが可能です。 ダウンロードして利用する場合は、依存している各ライブラリを別途ダウンロードする必要があります。

各ライブラリの利用方法については APIドキュメント の左上のプルダウンメニューから各言語を選択の上、閲覧できます。

各ライブラリの更新情報については、 開発者ブログ にてリリース時にお知らせしています。

Ruby

CRuby 2.1以上の環境での動作をサポートしています。

RubyGems.org で配布しています。 コマンドラインより、以下のコマンドを実行するか、

$ gem install webpay

Bundler環境下でGemfileに以下の通りに記述して利用できます。

gem 'webpay', '~>3.2'

また、以下gemファイル、ソースファイル群のzipファイルをダウンロードできます。

PHP

PHP 5.6以上の環境での動作をサポートしています。

Packagist で配布しています。 Composer環境下でcomposer.jsonに以下の通りに記述して利用できます。

{
  "require": {
    "webpay/webpay": "~2.3"
  }
}

また、以下ソースファイル群のzipファイルおよび、依存しているライブラリを含めたソースファイル群のzipファイルをダウンロードできます。

webpay-php-fullはどうしてもComposer環境が使えない場合のために提供しております。 各ライブラリの最新版を利用することが難しくなり、安全性に問題が生じることがあるため、可能なかぎりComposerを利用してください。 webpay-php-fullを利用する場合は、作成されたスクリプトと解凍したwebpay-php-full-2.3.2ディレクトリを同一のディレクトリに配置し、サンプルコード内の 'vendor/autoload.php''webpay-php-full-2.3.2/autoload.php' に読み替えてご利用ください。

ライブラリバージョン2.3.0より、PHP 5.6未満の環境では動作しなくなりました。止むをえない理由により5.6未満の環境を利用する場合はバージョンを2.2.2を指定してご利用ください。

Java

Java SE 6(1.6)以上の環境での動作をサポートしています。

Maven Central Repository で配布しています。

Maven環境下では、pom.xmlに

<dependency>
  <groupId>jp.webpay</groupId>
  <artifactId>webpay</artifactId>
  <version>[2.2.2,3.0.0)</version>
</dependency>

Gradle環境下では、build.gradleに

dependencies {
  compile 'jp.webpay:webpay:2.+'
}

と記述の上、インストールしてご利用ください。

また、以下jarファイル、sources-jar、javadoc、ソースファイル群のzipファイルをダウンロードできます。

Python

CPython 2.6以上の環境での動作をサポートしています。

PyPI で配布しています。pipを用いてコマンドラインから、以下のコマンドを実行することで利用できます。

$ pip install webpay

また、以下ソースファイル群のzipファイル、tar.gzファイルをダウンロードできます。

Node.js

Node.js 0.8以上(0.8, 0.10, 0.12)の環境での動作をサポートしています。

npm で配布しています。コマンドラインから、以下のコマンドを実行するか、

$ npm install webpay

package.jsonに

"dependencies": {
  "webpay": "^2.2.3"
}

と記述の上、

$ npm install

を実行してご利用ください。

また、以下ソースファイル群のzipファイルをダウンロードできます。

クライアントサイド向け

サーバサイドへクレジットカードの情報を送信せずに、 Tokenオブジェクトを作成するためのクライアントサイド向けのライブラリを以下のプラットフォーム向けに提供しています。

JavaScript(ブラウザ)

すぐに使える基本的なカード情報の入力インタフェースおよびトークン作成処理を提供するCheckoutHelperと、JavaScriptから利用するカスタマイズ可能なトークン作成ライブラリWebPay.jsを提供しています。 これらJavaScriptのライブラリはそれぞれの利用方法の通り、ダウンロードせずにリモートから読み込む形で利用してください。

CheckoutHelperやWebPay.jsを同一ページ内で複数回ロードした場合の動作は未定義です。 CheckoutHelperを複数表示したり、WebPay.jsとCheckoutHelperを同時にロードするような記述は避けてください。

CheckoutHelper

カード情報の入力インタフェースからトークンの作成までを全て行うCheckoutHelperは、HTML上のフォームのなかに

<script src="https://checkout.webpay.jp/v3/" class="webpay-button" data-key="test_public_19DdUs78k2lV8PO8ZCaYX3JT" data-lang="ja"></script>

と書くことで自動的にボタンが挿入されます。利用方法についての詳細はCheckoutHelperをご覧ください。

Content-Secure-Policyヘッダをご利用の場合は script-src https://checkout.webpay.jp https://api.webpay.jp; style-src 'unsafe-inline'; img-src data: を追加してください。

WebPay.js

トークンの作成を購入者のブラウザとWebPay間で行うライブラリWebPay.jsはHTML上で

<script type="text/javascript" src="https://js.webpay.jp/v1/"></script>

としてロードできます。機能についての詳細はトークン決済のクライアントサイドでのトークン化をご覧ください。

Content-Secure-Policyヘッダをご利用の場合は script-src https://js.webpay.jp https://api.webpay.jp を追加してください。

iOS

iOS7以上のiPhoneでの動作をサポートしています。

Tokenオブジェクトを作成するためのライブラリおよび、カード情報を入力するインタフェースを利用出来るライブラリとして webpay-token-ios を公開しています。

公開しているソースをダウンロードして利用するか、CocoaPodsを用いて、Podfileに

pod 'WebPay', '~> 2.0'

と記述してインストールすることが出来ます。利用方法については 開発者ブログでの記事 をご覧ください。

Android

Android2.2 (API level 8)以上のAndroid端末での動作をサポートしています。

Tokenオブジェクトを作成するためのライブラリおよび、カード情報を入力するインタフェースを利用出来るライブラリとして webpay-token-android を公開しています。

公開しているソースをダウンロードして利用するか、build.gradleファイル中に

dependencies {
  compile 'jp.webpay.android:webpay-token:1.0.0@aar'
}

と記述してインストールすることが出来ます。利用方法については 開発者ブログでの記事 をご覧ください。