Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version. Compare with Current  |   View Page History

<ac:macro ac:name="unmigrated-inline-wiki-markup"><ac:plain-text-body><![CDATA[

Zend Framework: Zend_Service_Rakuten Component Proposal

Proposed Component Name Zend_Service_Rakuten
Developer Notes http://framework.zend.com/wiki/display/ZFDEV/Zend_Service_Rakuten
Proposers TERUI Shingo, Satoru Yoshida
Ralph Schindler, Zend liaison
Revision ------10 Dec:add explanation parameters of searchItem, searchGenre and searchItemCode.
0.8 - 28 Nov 2008:I made APIs correspond from version 1.10 to 1.12 and I implemented the checking of the required parameters.
0.7 - 26 Dec: update References, Use Cases and Class Skeletons.
0.6 - 19 Dec: update References, Class Index, Use Cases and Class Skeletons.
0.5 - 11 Dec: update References, Use Cases and Class Skeletons.
0.4 - 22 Nov: update all except Dependencies and Milestones.
0.3 - 21 May: update class skeletons.
0.2 - 15 March 2007: add class skeletons. (wiki revision: 25)

Table of Contents

1. Overview

Zend_Service_Rakuten is a interface to use the "Rakuten Web service" that is provided by the Rakuten, Inc. .

2. References

The following links are API references written in Japanese. I write method names and brief description for each API.

  • Rakuten Web Service
    • for the Rakuten Market
      • ItemSearch
        • searchItem() - Search items.
          parameter type min max required default explanation
          - - - - - - following in params array
          affiliateId string - - - null affiliate id
          callBack string - - - null function name of Json call back
          keyword string - - may required null key word. One of keyword, genreId or catalogCode is required
          shopCode string - - - null shop code
          genreId int 0 - may required 0 genre id. One of keyword, genreId or catalogCode is required.
          catalogCode string - - may required null catalog code. One of keyword, genreId or catalogCode is required
          hits int 1 30 - 30 items per page.
          page int 1 100 - 1 page limits.
          sort string - - - standard sort type. ()affiliateRate, ()reviewCount, ()itemPrice, ()updateTimestamp, standard. (+-) means plus or minus mark, each mark means Ascend and Descend.
          minPrice int 0 - - null minimum price
          maxPrice int 0 - - null maximum price. It must be grater than minPrice
          availability int 0 1 - 1 0:all items, 1:only items that can be bought
          field int 0 1 - 1 0:search widely, 1:search narrowly
          carrier int 0 1 - 0 0:PC, 1:mobile
          imageFlag int 0 1 - 0 0:all item, 1:only items that has image
          orFlag int 0 1 - 0 0:AND keywords, 1:OR keywords
          NGKeyword string - - - null keyword that you want to omit
          genreInformationFlag int 0 1 - 0 0:not get information of genre, 1:get information (This method not support 1)
      • GenreSearch
        • searchGenre() - Retrieve genre's information
          parameter type min max required default explanation
          type string - - required child information type. child, parent or current
          genreId int 0 - required 0 genre id. If parent is specified, genre id must be grater than 0.
          - -
          - following in optparams array
          affiliateId string - - - null affiliate id
          callBack string - - - null function name of Json call back
      • ItemCodeSearch
        • searchItemCode() - Retrieve item's information by item code.
          parameter type min max required default explanation
          code string - - required - item code
          - -
          - following in optparams array
          affiliateId string - - - null affiliate id
          callBack string - - - null function name of Json call back
          carrier int 0 1 - 0 0:PC, 1:mobile
      • CatalogSearch
        • searchCatalog() - Search items by catalog.
      • ItemRanking
        • itemRanking() - Retrieve item ranking.
    • for the Rakuten Books
    • for the Rakuten Auction
    • for the Rakuten Travel
    • Other purpose
      • DynamicAd
        • dynamicAd() - Retrieve dynamic advertisements that is suitable for content in URL that you specify.

3. Component Requirements, Constraints, and Acceptance Criteria

  • Implements the "Rakuten Web Service" APIs.
  • Returns server responses as lightweight data objects.

4. Dependencies on Other Framework Components

  • Zend_Rest_Client
  • Zend_Service_Exception

5. Theory of Operation

Returns server response as the SimpleXMLElement.

6. Milestones / Tasks

  • Milestone 1: Class development and write proposal
  • Milestone 2: Unit tests and debugging
  • Milestone 3: Documentation

7. Class Index

  • Zend_Service_Rakuten

8. Use Cases

UC-01

Search 3 items by word, "Zend Studio". Its case is most simple case.

UC-02

Retrieve hotels that have vacant room for 1 adult person in the kasukabe city from today to tommorow.
The kasukabe city is in the saitama ward, and the saitama ward is in japan.
The checkinDate and checkoutDate are in Asia/Tokyo (GMT +9) time zone.

UC-03

Display advertisements that is suitable for www.zend.com .
dynamicAd() needs your affiliate ID from the Rakuten web service.

9. Class Skeletons

]]></ac:plain-text-body></ac:macro>

Labels:
None
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.