Guidelines for Game Report Submissions

Pull

This is the preferred method as it allows for batch processing and (generally) is easier for the participating game site. This method involves you giving the IAGO aggregator an RSS feed that lists the game reports you have available. The aggregator then fetches and processes the reports it thinks are pertinent.

  • The aggregator currently resides at: http://iagoweb.com/records/aggregator.
  • To request the aggregator to fetch your site information you must:
    1. Register the site with IAGO and receive your site ID string.
    2. Register with IAGO the domain(s) from where your RSS feeds will originate.
    3. Generate an RSS1.0-compatible feed that includes the “title” attribute, which provides an ID number or string that uniquely identifies this game on your site. This ID must remain unique! The “link” attribute must provide the URL where the aggregator can find the record for the game in question. (Note: This feed does not contain the report itself! Just a URL where it can be fetched.)
    4. Send a POST to http://iagoweb.com/records/aggregator/SITEID that includes a single parameter named either “url”, “link”, or “feed” that contains the URL of the RSS feed generated above. Provided that URL matches a registered domain, the request gets added to the queue. The system will return a correct HTTP response and content message depending on the results of the request.
    5. Periodically the aggregator will run a batch and process these requests. You can view the status of your request by using your browser to GET the URL you pinged previously. If an error occurs while processing any records, it will inform you there.

Push

For some situations, however, PUSHing may be preferable. This involves POSTing individual game reports to the database. To do this you must:

  1. Register with IAGO and receive your site ID string.
  2. Visit your site's admin screen (records/sites/SITEID) and generate an authorization token.
  3. Send a POST request to http://iagoweb.com/records/reports/new/SITEID that includes the following query paramters:
    • token: This is one of the authorization tokens currently associated with your site.
    • report: The well-formed, valid game report, adhering to the official XML schema.
  4. The system will return a correct HTTP response and plain text content message depending on the results of the request.
 
/home/html/iago/HTML/wiki/data/pages/formal/tech/submit.txt · Last modified: 2010/03/02 13:39 by aaron
 
Except where otherwise noted, content on this wiki is licensed under the following license:CC Attribution-Noncommercial-Share Alike 3.0 Unported
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki