Blitzaroo API
About
Blitzaroo will support a full featured RESTful API which allows developers to access core Blitzaroo data. This includes games, races, classes, events, characters, signups, and more. This document will provide a rundown of the Blitzaroo API as I implement features and is intended to be used as feedback from the community on possible concerns or features they would like to see implemented. Once Blitzaroo is live this information will be ported over to http://www.blitzaroo.com/api.
Rate Limiting
Not yet implemented.
Authentication
Not yet implemented.
REST API Methods
Here is a list of available REST API. Developers wanting to use the Blitzaroo API should read and understand this document in its entirety to remove the risk of being blacklisted.
Generic Information
All REST requests should be made to http://www.blitzaroo.com/api/. All responses will be generated in XML or JSON based on the format you specify. All requests will be returned with the following information:
- request – the request that was made
- items OR error – a list of items or an error message if an error occurred
All requests will also be sent with appropriate HTTP status codes.
- 200 OK: Success!
- 304 Not Modified: There was no new data to return.
- 400 Bad Request: The request was invalid. An accompanying error message will explain why.
- 401 Not Authorized: Authentication credentials were missing or incorrect.
- 403 Forbidden: The request is understood, but it has been refused. An accompanying error message will explain why.
- 404 Not Found: The URI requested is invalid or the resource requested, such as a user, does not exists.
- 406 Not Acceptable: Returned by the Search API when an invalid format is specified in the request.
- 500 Internal Server Error: Something is broken.
- 502 Bad Gateway: Blitzaroo is down or being upgraded.
- 503 Service Unavailable: The Blitzaroo servers are up, but overloaded with requests. Try again later.
Class Methods
classes/
Returns information of all classes. Results can be filtered based on game_id or race_id.
URL:
http://www.blitzaroo.com/api/classes
Formats:
xml, json
HTTP Method(s):
GET
Requires Authentication:
false
Parameters:
The following is required:
- format. The format to use (json, xml).
Any of the following are allowed:
- game_id. The ID of the game.
- race_id. The race required to be the class.
Response
{ request: "/api/classes?format=json" items: [{ id: 1 parent_id: game_id: 1 name: "Mage" }, { id: 2 parent_id: game_id: 1 name: "Priest" }, { id: 3 parent_id: game_id: 1 name: "Scout" }, { id: 4 parent_id: game_id: 1 name: "Warrior" }] }
Example
http://www.blitzaroo.com/api/classes?format=json