Skip to content
README.markdown 1.64 KiB
Newer Older
steve's avatar
steve committed
Topspin Drupal Module
===
Kris Wehner's avatar
Kris Wehner committed

A module that integrates with Topspin's (http://topspinmedia.com) REST API.
 
Topspin API Documentation: http://docs.topspin.net


PROJECT PAGE
steve's avatar
steve committed
===
Kris Wehner's avatar
Kris Wehner committed

http://drupal.org/project/topspin
 
 
REQUIREMENTS
steve's avatar
steve committed
===
Kris Wehner's avatar
Kris Wehner committed

* PHP 5.2.x
* jSON enabled for PHP
* cURL enabled for PHP
* A Topspin account with an API key.


FEATURES
steve's avatar
steve committed
===
Kris Wehner's avatar
Kris Wehner committed

* Connection API for making requests from the REST API.
  topspin_request($method, $parameters);

nrobillard's avatar
nrobillard committed
* A general configuration form at admin/settings/topspin.
* Topspin content import at admin/content/topspin.
* Default store at admin/settings/topspin/store/1 and ability to create additional stores.
* Most Popular as well as individual offers can be configured as blocks from admin/settings/topspin and then enabled in a region at admin/build/block.
Kris Wehner's avatar
Kris Wehner committed

nrobillard's avatar
nrobillard committed
USAGE
===

The following steps will result in a functioning store front showing imported Topspin content.

nrobillard's avatar
nrobillard committed
* Enable the Topspin Media and Topspin Media CCK modules at admin/build/modules.
nrobillard's avatar
nrobillard committed
* Now set up your Topspin credentials and choose which artists you want to pull content from at admin/settings/topspin.
nrobillard's avatar
nrobillard committed
* If you selected "Check for new offers and update automatically", you can wait until a cron run imports your content. Regardless of which option you chose, you can always manually import content at admin/content/topspin.
nrobillard's avatar
nrobillard committed
* Now you can configure your store front. You can configure the default store admin/settings/topspin/store/1 or you can create a new one admin/settings/topspin/store/add.
nrobillard's avatar
nrobillard committed
* You are finished. Go to your store path to see your new store front.
Kris Wehner's avatar
Kris Wehner committed

AUTHOR/MAINTAINER
steve's avatar
steve committed
===
Kris Wehner's avatar
Kris Wehner committed

* 80 Elements Entertainment (http://80elements.com)
steve's avatar
steve committed
* Topspin Media (http://topspinmedia.com)
Kris Wehner's avatar
Kris Wehner committed