You are here

Home » API reference » Amazon Product Advertisement API 6

README.txt in Amazon Product Advertisement API 6

Same filename and directory in other branches
  1. 7.2 README.txt
  2. 7 README.txt
Amazon.module API Documentation
===============================

The Amazon package gives Drupal based web sites access to the core features of 
the Amazon Product Marketing API. The package provides several components:

1) A core API module that communicates with Amazon's web services and adds 
   support for retrieving, displaying, and storing basic product information 
   in Drupal as well as associating Amazon products with content nodes. 
2) A field type (and an accompanying set of formatters) for CCK that allows 
   Amazon products to be explicitly added to any node type. 
3) An 'Amazon Media' module that adds support for Amazon's extended product 
   information for several common product types (Books, Music, DVDs, and 
   Software).
4) An 'Amazon Search' module that allows developers to conduct API-driven 
   searches of the Amazon product database. This module also allows users to 
   search Amazon's product database from Drupal's Advanced Search page.

Most users and site builders will want to enable the basic Amazon API module, 
as well as the Amazon Field and Amazon Media modules. These provide the 
functionality that the majority of simple sites need. 

For more information, visit the project page at http://drupal.org/project/amazon 
and the project documentation at http://drupal.org/node/595464.

Amazon API conventions
======================

- All element keys are lowercased for consistency
- The Amazon ItemAttributes collection is merged into the top level of the 
  Drupal entity for simplicity.
- Information outside the 'common' ItemAttributes, Product Images, and 
  Artist/Author/Etc. data must be handled by external third-party modules.
- Authors, Directors, and other creator information is stored in the generic 
  $item['participants'] array. It's a crummy name, but until I come up with
   something better it'll have to do. A separate array for each participant type 
   is also created.

File

README.txt
View source 
  1. Amazon.module API Documentation

  2. ===============================

  3. 

  4. The Amazon package gives Drupal based web sites access to the core features of 

  5. the Amazon Product Marketing API. The package provides several components:

  6. 

  7. 1) A core API module that communicates with Amazon's web services and adds 

  8.    support for retrieving, displaying, and storing basic product information 

  9.    in Drupal as well as associating Amazon products with content nodes. 

  10. 2) A field type (and an accompanying set of formatters) for CCK that allows 

  11.    Amazon products to be explicitly added to any node type. 

  12. 3) An 'Amazon Media' module that adds support for Amazon's extended product 

  13.    information for several common product types (Books, Music, DVDs, and 

  14.    Software).

  15. 4) An 'Amazon Search' module that allows developers to conduct API-driven 

  16.    searches of the Amazon product database. This module also allows users to 

  17.    search Amazon's product database from Drupal's Advanced Search page.

  18. 

  19. Most users and site builders will want to enable the basic Amazon API module, 

  20. as well as the Amazon Field and Amazon Media modules. These provide the 

  21. functionality that the majority of simple sites need. 

  22. 

  23. For more information, visit the project page at http://drupal.org/project/amazon 

  24. and the project documentation at http://drupal.org/node/595464.

  25. 

  26. Amazon API conventions

  27. ======================

  28. 

  29. - All element keys are lowercased for consistency

  30. - The Amazon ItemAttributes collection is merged into the top level of the 

  31.   Drupal entity for simplicity.

  32. - Information outside the 'common' ItemAttributes, Product Images, and 

  33.   Artist/Author/Etc. data must be handled by external third-party modules.

  34. - Authors, Directors, and other creator information is stored in the generic 

  35.   $item['participants'] array. It's a crummy name, but until I come up with

  36.    something better it'll have to do. A separate array for each participant type 

  37.    is also created.