API Overview

From King Arthur's Gold Wiki
Revision as of 07:17, 4 March 2012 by FliesLikeABrick (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

King Arthur's Gold has an API under development. This page and others on the kagwiki will serve as official documentation for how to use this API.

The API is planned to be 100% RESTful and uses JSON for all responses. HTTP request verbs and response codes are used appropriately and should be obeyed.

The API is/will be used for the following:

  • Client authentication (both when the client opens and when joining a server)
  • Server registration in the master list
  • Client retrieval of the server list and server details

Future uses:

  • 3rd party retrieval of forum and KAG account profile information (avatars, signatures, etc)
  • Querying for KAG account status (gold/not activated/banned)
  • Sekrit features to be determined/announced

Some of the features documented here are intended for internal use by components of KAG only. They may technically be usable by 3rd party applications and sites, however their use is discouraged for various reasons. Documented features which fall into this category will have warnings posted.