Giter Club home page Giter Club logo

gerritonagoodday / auction-affiliate Goto Github PK

View Code? Open in Web Editor NEW
0.0 2.0 0.0 823 KB

This Joomla Module displays an eBay auction item on a your Joomla! web site. Highly configurable. One auction item per module. Multiple modules possible. Optional affiliate tracking included. No hidden affiliate trackers! Unlike other similar modules, works on restrictive shared-hosting environments too.

License: GNU General Public License v3.0

Shell 8.56% HTML 0.70% CSS 2.38% PHP 88.36%

auction-affiliate's Introduction

Auction Affiliate - A Joomla! Module for eBay Auctions

To advertise your eBay auction, direct web traffic to it and to draw affiliation revenue

This module displays an eBay auction item in a Joomla! web page in a Joomla module position. To display multiple auction items, simply instantiate multiple modules. The auction item(s) can be your own auction, a friend's or that of someone unknown. Through this module, a visitor can go directly to eBay from your website, bid and complete a successful transaction. You can choose what information about the item you want to display and optionally wether you want to enable eBay affiliation. If you are a registered affiliate, you will receive an affiliation fee in recognition of having facilitated the succcessfull transaction.

Table of Contents

NOTE:

You can update this TOC as follows:

 awk '/^#/ {gsub(/#/,"  ",$1); printf "%s- ", $1; $1=""; sub(/^ /,"");  printf "[%s]", $0; gsub(/\s+/,"-"); gsub(/[\!|\?\:]/,""); printf "(#%s)\n", tolower($0)}' README.md 

Why is this module useful?

  • It offers an easy way of showing your website visitors what you are selling on eBay
  • Simple configuration - the mimimum configuration you need to do to set it up in an good position in your template and to enter the eBay Item number in the module configuration. There are lots of other nice goodies to configure in the module too, by the way.
  • Manages affiliation tracking of your selected eBay auction.
  • Use it to direct web traffic to your eBay auction, which means that more people will bid, which in turn means that you can potentially realize a higher final auction sale value.
  • Remember, you can set this affiliation up for anybody's item on eBay, not just your own items.

What does it do?

It displays the following:

  • Auction item image
  • Item Description
  • Date and Time of auction/sale end
  • Remaining time countdown to auction/sale end
  • Number of bids so far
  • Price and currency
  • Location and country of item
  • Auction status: Active or Completed

It also manages:

  • The retrieval of the auction data
  • Tracker affiliation

Supports:

  • JSON and XML API encoding
  • Uses cURL if PHP's file_get_contents is disabled on your web server (often the case on shared hosting servers)

This is ow it works

The Care, Feeding and Configuration of your Module

You can only configure one auction item per module. If you want to show multiple auction items, then set up multiple modudes instances on your Joomla website. Since the amount of information you display is so configurable, you can reduce the module size and display, say, 6 of these modules below each other in a side column for 6 auction items.

This is what you can configure

The frequently-configured bits

  • Auction Item Id - a 12-digit number, which you copy and paste from the eBay web page in the Description section where it says: "eBay item number: XXXXXXXXXXXX", or from the URL
  • Comment - you can add an additional comment about the auction item. If left blank, no comment will be displayed.
  • eBay API account Id in the form XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX. You get this Id when you register at http://developer.ebay.com. By default, the authors's API Id is set on in the module already to get you started, but strictly speaking, you should replace it with your own API account Id.

The less frequently-configured bits

  • Image width. eBay images are by default 400x300 px in size, which is too large for a typical Joomla module in a margin of a web page. The recommended default is 200 pixels wide.
  • Source Site - select the one eBay that this item is hosted on. eBay currenly support 22 such site, so make sure you choose the correct one.
  • Time zone - Auction times are displayed in terms of this time zone. It is useful to use the time zone that the item is located in, but you can alternatively choose the time zone where most of your users will be viewing this item from.

The occasionally-configured bits

  • Display location - displays the town and country where the item is located.
  • Display eBay logo - if you are pushed for space, disable this.
  • Display image - if you want to save space or only want to display the item's title text, disable this.

The seldomly-configured bits

  • Enable affiliation - if you are a registered affiliate, you can use this item for revenue generation.
  • Affiliate Partner - eBay currently works with 8 affiliate partners, including itself. Choose the one that you are registered with. You have enabled affiliation, right?
  • Tracking Id - The Id by which you are known to your affiliate partner.

The mega-geek bits

  • Sandbox enable - if you want to end-to-end test entire eBay transaction through this module, this options lets you use the eBay sandbox environment and not incur any transaction fees.
  • API Encoding - if you use PHP version >= 5.12, then the API encoding is done with JSON. Older versions of PHP only work with XML.
  • Debug - enable this to display the content of the API calls displayed. This setting is not affected by the Global Debug setting, nor does this setting affect the Global one.

Installation

Steps:

  • You have Joomla installed on your webserver, right?
  • The module's ZIP package is installed using the standard Joomla Component Installer mechanism.

Uninstallation

Uninstall the module through the Joomla Extension Manager. You will loose your configuration data, so jot down the details first if they are important to you.

Support

You can get further support here: https://github.com/gerritonagoodday/auction-affiliate, or contact the author directly at [email protected]. Also see www.hoekstra.co.uk for more details and often and actual eBay item on display.

Known bugs and Feature Requests

Lodge any issues you find and feature requests here:

https://github.com/gerritonagoodday/auction-affiliate/issues

Licensing

This is the brave new world of open source where giants cower in fear of the little man who releases a nice bit of usefull free software. Well, maybe not this piece of software, but you get the drift. Anywayz, it's GPL2-licensed.

F.A.Q.

How do I show many auction items on a page?

You can do this by first installing Modules Anwhere from Regular Labs, which allows to instantiate a module using just its ID anywhere in an article. It is best to do this in the cell of a table or a responsive grid (see HTML below). You still need to create each module - here the module IDs as listed in the Joomla Extension Manager page ranged from 91 to 96:

<table cellspacing="5" cellpadding="5">
  <tbody>
    <tr>
      <td>{module id="96"} </td>
      <td>{module id="91"} </td>
      <td>{module id="92"} </td>
    </tr>
    <tr>
      <td>{module id="93"} </td>
      <td>{module id="94"} </td>
      <td>{module id="95"} </td>
    </tr>
  </tbody>
</table>

This should give you something that looks like this:

Many auction items on a page

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.