Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement namespace Rakuten\WebService` #27

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Implement namespace Rakuten\WebService` #27

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6086e0a
Update Travis-CI configuration
andrew-miller-rakuten Jun 5, 2019
f8a4ade
Add namespacing
andrew-miller-rakuten Jun 5, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@
language: php

sudo: false

php:
- 5.3
- 5.4
- 5.5
- 5.6
- 7.1
- 7.2
- 7.3
- nightly

matrix:
allow_failures:
- php: nightly

before_install:
- travis_retry composer self-update

install:
- travis_retry composer update --prefer-dist --no-interaction --prefer-stable

script: vendor/bin/phpunit
55 changes: 26 additions & 29 deletions README.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,38 +1,36 @@
Rakuten Web Service SDK for PHP
===============================

[![Build Status](https://secure.travis-ci.org/rakuten-ws/rws-php-sdk.png?branch=master)](http://travis-ci.org/rakuten-ws/rws-php-sdk)
[![Build Status](https://secure.travis-ci.org/rakuten-ws/rws-php-sdk.png?branch=master)](https://travis-ci.org/rakuten-ws/rws-php-sdk)

Rakuten Web Service SDK for PHP is a library to make it easy to connect to the Rakuten APIs.

Requirement
-----------

- PHP5.2.3+ (Recommended: PHP5.2.10+ with [curl extension](http://php.net/manual/en/book.curl.php))
- If you want to use this library on PHP5.2.10-, please install [HTTP_Client](http://pear.php.net/manual/en/package.http.http-client.php) on PEAR
or curl extension.
- PHP 7.1.0+ (Recommended: PHP 7.3.0+ with [curl extension](https://php.net/manual/en/book.curl.php))

Download
--------

You can download SDK from following links.

- [Stable 1.1.0 - zip](https://github.com/rakuten-ws/rws-php-sdk/archive/1.1.0.zip)
- [Stable 2.0.0 - zip](https://github.com/rakuten-ws/rws-php-sdk/archive/2.0.0.zip)
- [Source Code (Github)](https://github.com/rakuten-ws/rws-php-sdk)

RWS PHP SDK is registered at [Packagist](http://packagist.org/).
Therefore, you can get and manage the library with [Composer](http://getcomposer.org).
RWS PHP SDK is registered at [Packagist](https://packagist.org/).
Therefore, you can get and manage the library with [Composer](https://getcomposer.org).

Get composer

curl -s http://getcomposer.org/installer | php
curl -s https://getcomposer.org/installer | php

Create *composer.json* file in the project root:


{
"require": {
"rakuten-ws/rws-php-sdk": "1.*"
"rakuten-ws/rws-php-sdk": "2.*"
}
}

Expand All @@ -44,10 +42,9 @@ Install
Basic Usage
-----------

Please register your application using our Web Service site (http://webservice.rakuten.co.jp).
Please register your application using our Web Service site (https://webservice.rakuten.co.jp).

Next, load *autoload.php* in your application.
The *autoload.php* file is in the same directory as this readme file.
Next, load *vendor/autoload.php* in your application.
Now you can use the library.

For APIs that don't need user authorization, like IchibaItemSearch API and Books API,
Expand All @@ -56,9 +53,9 @@ you can fetch data by following this sample code.
```php
<?php

require_once '/path/to/sdk-dir/autoload.php';
require_once __DIR__.'/vendor/autoload.php';

$client = new RakutenRws_Client();
$client = new Rakuten\WebService\Client();
// Please set your Application ID
$client->setApplicationId('YOUR_APPLICATION_ID');

Expand All @@ -79,11 +76,11 @@ if ($response->isOk()) {
}
```
You can pass "API Name (string)", "Request Paramters (array)", and
"version" to *RakutenRws_Client::execute()* method.
"version" to *Rakuten\WebService\Client::execute()* method.
"version" is an optional parameter. If you don't specify the "version" then the library will
auotmatically select the latest version.

The following APIs support [Iterator (http://php.net/manual/en/class.iterator.php)],
The following APIs support [Iterator (https://php.net/manual/en/class.iterator.php)],
so you can access each item's data with a foreach statement.

* AuctionGenreKeywordSearch
Expand Down Expand Up @@ -117,9 +114,9 @@ Example:
```php
<?php

require_once '/path/to/sdk-dir/autoload.php';
require_once __DIR__.'/vendor/autoload.php';

$client = new RakutenRws_Client();
$client = new Rakuten\WebService\Client();
$client->setApplicationId('YOUR_APPLICATION_ID');
$client->setAffiliateId('YOUR_AFFILIATE_ID');

Expand All @@ -141,14 +138,14 @@ To access APIs that need user's authorization, like the RakutenBookmark API,
you need to get an *access_token* in advance.

First, send the user to the authorization page. You can get the authorization page URL with the following code.
At the same time, please don't forget the scope in *RakutenRws_Client::getAuthorizeUrl()*.
At the same time, please don't forget the scope in *Rakuten\WebService\Client::getAuthorizeUrl()*.

```php
<?php

require_once '/path/to/sdk-dir/autoload.php';
require_once __DIR__.'/vendor/autoload.php';

$client = new RakutenRws_Client();
$client = new Rakuten\WebService\Client();
// Set Application ID
$client->setApplicationId('YOUR_APPLICATION_ID');
// Set Application Secret
Expand All @@ -167,9 +164,9 @@ You can access API by this *access_token*.
```php
<?php

require_once '/path/to/sdk-dir/autoload.php';
require_once __DIR__.'/vendor/autoload.php';

$client = new RakutenRws_Client();
$client = new Rakuten\WebService\Client();
// Set Application ID
$client->setApplicationId('YOUR_APPLICATION_ID');
// Set Application Secret
Expand Down Expand Up @@ -203,16 +200,16 @@ if ($response->isOk()) {
Proxy Configuration
-------------------

You can use this API with a proxy. Please set proxy information with *RakutenRws_Client::setProxy()*.
You can use this API with a proxy. Please set proxy information with *Rakuten\WebService\Client::setProxy()*.

Example:

```php
<?php

require_once '/path/to/sdk-dir/autoload.php';
require_once __DIR__.'/vendor/autoload.php';

$client = new RakutenRws_Client();
$client = new Rakuten\WebService\Client();
// Set proxy
$client->setProxy('proxy-host.example.com:port');
$client->setApplicationId('YOUR_APPLICATION_ID');
Expand All @@ -228,19 +225,19 @@ $response = $client->execute('ItemSearch', array(
Sample Code
-----------

- There is sample code in the [sample] (https://github.com/rakuten-ws/rws-php-sdk/tree/master/sample) directory.
- There is sample code in the [sample](https://github.com/rakuten-ws/rws-php-sdk/tree/master/sample) directory.
- Please rename *config.php.sample* and set Application ID, Application Secret and Affiliate ID.

Official API Document
---------------------

- http://webservice.rakuten.co.jp
- https://webservice.rakuten.co.jp


SDK API Document
----------------

- [API Docs](http://webservice.rakuten.co.jp/sdkapi/php/)
- [API Docs](https://webservice.rakuten.co.jp/sdkapi/php/)

License
-------
Expand Down
51 changes: 24 additions & 27 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Rakuten Web Service SDK for PHP

There is an English version in [here](https://github.com/rakuten-ws/rws-php-sdk/blob/master/README.en.md).

[![Build Status](https://secure.travis-ci.org/rakuten-ws/rws-php-sdk.png?branch=master)](http://travis-ci.org/rakuten-ws/rws-php-sdk)
[![Build Status](https://secure.travis-ci.org/rakuten-ws/rws-php-sdk.png?branch=master)](https://travis-ci.org/rakuten-ws/rws-php-sdk)

Rakuten Web Service SDK for PHP は、PHPアプリケーションから
楽天が提供しているAPIに、簡単にアクセスすることができるSDK
Expand All @@ -12,24 +12,22 @@ Rakuten Web Service SDK for PHP は、PHPアプリケーションから
動作要件
--------

- PHP5.2.3以上 (PHP5.2.10以上, [curl拡張](http://php.net/manual/ja/book.curl.php) 導入を推奨)
- PHP5.2.10未満を利用する場合、PEAR の [HTTP_Client](http://pear.php.net/manual/ja/package.http.http-client.php)
か curl拡張の導入が必要です。
- PHP7.1.0以上 (PHP5.2.10以上, [curl拡張](https://php.net/manual/ja/book.curl.php) 導入を推奨)

ダウンロード
------------

以下からSDKをダウンロードすることができます。

- [最新版 1.1.0 - zipアーカイブ](https://github.com/rakuten-ws/rws-php-sdk/archive/1.1.0.zip)
- [最新版 2.0.0 - zipアーカイブ](https://github.com/rakuten-ws/rws-php-sdk/archive/2.0.0.zip)
- [ソースコード (Github)](https://github.com/rakuten-ws/rws-php-sdk)

また、RWS PHP SDK は、[Packagist](http://packagist.org/) にパッケージ登録を行っています。
そのため、 [Composer](http://getcomposer.org/) を通してパッケージを入手することができます。
また、RWS PHP SDK は、[Packagist](https://packagist.org/) にパッケージ登録を行っています。
そのため、 [Composer](https://getcomposer.org/) を通してパッケージを入手することができます。

composer を入手します

curl -s http://getcomposer.org/installer | php
curl -s https://getcomposer.org/installer | php

あなたの開発プロジェクトのルートに composer.json を作成します。

Expand All @@ -47,20 +45,19 @@ composer を通してパッケージを入手します
基本的な使い方
--------------

事前に、楽天ウェブサービスのドキュメントページ(http://webservice.rakuten.co.jp)
事前に、楽天ウェブサービスのドキュメントページ(https://webservice.rakuten.co.jp)
にて、アプリ登録を行ってください。

このドキュメントと同じディレクトリにある *autoload.php* を読み込むことにより、
SDK の利用準備が整います。
*vendor/autoload.php*を読み込むことにより、SDKの利用準備が整います。

ユーザ認証の必要のない、APIについては、以下のように情報を取得することができます。

```php
<?php

require_once '/path/to/sdk-dir/autoload.php';
require_once __DIR__.'/vendor/autoload.php';

$client = new RakutenRws_Client();
$client = new Rakuten\WebService\Client();
// アプリID (デベロッパーID) をセットします
$client->setApplicationId('YOUR_APPLICATION_ID');

Expand All @@ -81,7 +78,7 @@ if ($response->isOk()) {
}
```

*RakutenRws_Client::execute()* には、API名、パラメータ、バージョンを
*Rakuten\WebService\Client::execute()* には、API名、パラメータ、バージョンを
指定します。そのうち、バージョンについては省略することが可能で、
省略した場合、自動的にSDKが指定した最新バージョンを選択します。

Expand Down Expand Up @@ -119,9 +116,9 @@ foreach で 情報(商品情報・施設情報など) を順次取得するこ
```php
<?php

require_once '/path/to/sdk-dir/autoload.php';
require_once __DIR__.'/vendor/autoload.php';

$client = new RakutenRws_Client();
$client = new Rakuten\WebService\Client();
$client->setApplicationId('YOUR_APPLICATION_ID');
$client->setAffiliateId('YOUR_AFFILIATE_ID');

Expand All @@ -143,14 +140,14 @@ FavoriteBookmarkAPI (楽天ブックマーク系API) のようなユーザ認証
APIを使う場合は、 *access_token* を取得する必要があります。

まず、ユーザを認証ページに誘導してください。認証ページのURLは、以下のように取得することができます。
この時、 *RakutenRws_Client::getAuthorizeUrl()* には、API利用スコープを設定することを忘れないください。
この時、 *Rakuten\WebService\Client::getAuthorizeUrl()* には、API利用スコープを設定することを忘れないください。

```php
<?php

require_once '/path/to/sdk-dir/autoload.php';
require_once __DIR__.'/vendor/autoload.php';

$client = new RakutenRws_Client();
$client = new Rakuten\WebService\Client();
// アプリID (デベロッパーID) をセットします
$client->setApplicationId('YOUR_APPLICATION_ID');
// Secret をセットします
Expand All @@ -169,9 +166,9 @@ echo $client->getAuthorizeUrl('rakuten_favoritebookmark_read');
```php
<?php

require_once '/path/to/sdk-dir/autoload.php';
require_once __DIR__.'/vendor/autoload.php';

$client = new RakutenRws_Client();
$client = new Rakuten\WebService\Client();
// アプリID (デベロッパーID) をセットします
$client->setApplicationId('YOUR_APPLICATION_ID');
// Secret をセットします
Expand Down Expand Up @@ -206,16 +203,16 @@ if ($response->isOk()) {
プロキシの設定
--------------

*RakutenRws_Client::setProxy()* で、プロキシを通してAPIにアクセスすることができます。
*Rakuten\WebService\Client::setProxy()* で、プロキシを通してAPIにアクセスすることができます。

以下が利用例になります

```php
<?php

require_once '/path/to/sdk-dir/autoload.php';
require_once __DIR__.'/vendor/autoload.php';

$client = new RakutenRws_Client();
$client = new Rakuten\WebService\Client();
$client->setProxy('proxy-host.example.com:port');
$client->setApplicationId('YOUR_APPLICATION_ID');
$client->setAffiliateId('YOUR_AFFILIATE_ID');
Expand Down Expand Up @@ -254,18 +251,18 @@ $response = $client->execute('IchibaItemSearch', array(
サンプルコード
-------------

- [sample] (https://github.com/rakuten-ws/rws-php-sdk/tree/master/sample) ディレクトリにサンプルを用意しています。
- [sample](https://github.com/rakuten-ws/rws-php-sdk/tree/master/sample) ディレクトリにサンプルを用意しています。
- config.php.sample を config.php にリネームし、アプリID, application_secret をセットすることで動作します。

公開APIドキュメント
-------------------

- http://webservice.rakuten.co.jp
- https://webservice.rakuten.co.jp

SDK API Document
----------------

- [API Docs](http://webservice.rakuten.co.jp/sdkapi/php/)
- [API Docs](https://webservice.rakuten.co.jp/sdkapi/php/)

ライセンス
----------
Expand Down
4 changes: 0 additions & 4 deletions autoload.php
View file
Open in desktop

This file was deleted.

Loading