Welcome to the Goozex API documentation. Here you will find all the info you need to build fun projects that work with Goozex and extend the service with new features!
Introduction to the Goozex API
The Goozex API is a set of publicly available API
(Application Program Interface) methods that allow accessing the Goozex system
from external applications. Each API method performs a specific function and provides a reply in a specific formats, normally XML/RSS. Some API commands return results in Javascript (suitable for posting on webpages) and others redirect to a specific web page on Goozex.com (useful for web integration). They are REST-like commands accessible over HTTP through a remote URL.
Please note: access and use of the Goozex API is subject to the API Terms of Use.
Concepts
Use of the Goozex API is based on HTTP request/response methods. Some info you may want to know before using it:
Authentication
For the time being, access to the Goozex API is public (no authentication is required). However, there are a few procedures you must follow to ensure proper use of the API and future compatibility:
App_name code: all requests sent to the API require an app_name code. This is a unique identifier of your specific application. The code is used to track usage statistics from each application, and will be used in the future to verify an application's right to access the API. You must use an app_name for each API request you make. You can request an app_name code here.
User login: authentication is needed for those commands that return information about a specific user (for example, the list of requests). Authentication is based on Username + TokenID of the specific user, passed in the querystring to the API script. Each user can find its own TokenID on the My Account page (at the bottom).
HTTP Requests
Unless otherwise noted, methods exposed by the Goozex API require a GET request. All parameters are passed in the query string.
Parameters
Some API methods take optional or requisite input parameters. Where applicable, we’ve documented those parameters. Remember to convert to UTF-8 and URL encode parameters that take complex strings.
Conventions and IDs
The IDs returned by the API responses are Goozex IDs. Please refer to the
Goozex IDs and data conventions page for more information.
Rate limiting / throttling
The API currently has no limit on the number of
requests applications can make. Please be kind to the API so we can
keep it that way and try to use the minimum number of requests to
accomplish a task. As a guideline, we recommend a maximum of 1 request every 15 minutes for the user's lists (requests, offers), game updates and new releases.
API Categories
The Goozex API is currently divided into three main categories: RSS/XML commands, Javascript components, and Web commands. Each one is suitable for different applications.
API: RSS
Response format: Responses to these API commands are given in RSS/XML format.
The returned XML responses are easily parsed to use the data in custom applications. These are the most versatile API commands available and allow you to access most of the information available on Goozex with a simple RSS/XML parsing script.
Usage examples: Widgets, external applications, Facebook applications, Flash applications, iGoogle
List of API commands:
API: JS
Response format: These scripts return Javascript components that can be easily embedded in third-party websites.
These scripts allow for integration of Goozex features into an extrernal website. For example, you can use the API: JS commands to post a Goozex Top 10 list that is automatically updated on a weekly basis, or to post a "trade it on Goozex" button to allow your visitors to trade their games on Goozex. These scripts can be customized with a partner/affiliate code to track performances (contact us for more info)
Usage examples: Integration on third-party websites
List of API commands:
API: WEB
Response format: Results to these commands are returned on a web page on Goozex.com.
These scripts allow for integration of Goozex features into an
extrernal website or for the development of applications that show result on a Goozex.com web page. For example, a Google Toolbar button that allows to search for games and returns the list of results on a Goozex.com web page.
Usage examples: Integration on third-party websites, browser toolbars, widgets
List of API commands:
License
Usage of the Goozex API is subject to the API Terms of Use. In general, you are invited to use the Goozex API to build applications and widgets for you own use or that you make available to all other Goozex members. You are also welcome to use the API to post content on your web site as long as you keep all links back to Goozex.com.
All applications and widgets developed with the Goozex API must be released under the GNU license. The Goozex API cannot be used for commercial purposes unless otherwise authorized by Goozex in writing.
List of applications
Members are welcome to post their own applications and widget on the Member applications forum. This is also a great place to get feedback from other members!
Select applications are also made available to all members in the Goozex Toolbox section.
Sample script
We have posted a sample script in PHP to showcase how to use the Goozex API. Click here to learn more!
Help and support
The easiest way to get help with the Goozex API is to check out our API Support forum. Feel free to join and ask questions, suggest improvements, and collaborate on projects.
Is there something you want from the Goozex API that you can't seem to find? Try posting to the API Support forum with the information you'd like from the API. More API endpoints will
be added to the API depending on input from developers like you.
