Ryzom API

h1. Character

Access character information.

h2. Base URL

* http://api.ryzom.com/character.php?apikey=key

* http://api.ryzom.com/character.php?apikey[]=key1&apikey[]=key2

h2. URL Parameters

h3. @apikey@

Character [[API key]].

h2. Cache Duration

*<character>* xml element has attributes *created* and *cached_until* (utc timestamp)

h2. PHP Interface

h3. @ryzom_character_api($apikey)@

@$apikey@ can be either string (single key) or array of strings.

On success, function returns associative array of *SimpleXMLElement* with @$apikey@ as array index.

On failure, function returns boolean *false*.

h2. XML structure

API is able to return information about multiple characters at once and so each *<character>* element is child of *<ryzomapi>* root element

<pre><code class="xml">

<ryzomapi>

  <character apikey="key1" created="1387369332" modules="C01:P01" cached_until="1387369632">

    ....

  </character>

  <character apikey="key2" created="1387369332" modules="P01" cached_until="1387369632">

    ....

  </character>

</ryzomapi>

</code></pre>

h3. Invalid key error

When provided key is invalid, then *<character>* element contains *<error>* element with *code* attribute.

<pre><code class="xml">

<character apikey="key1" created="1387369873">

  <error code="404">invalid key</error>

</character>

</code></pre>

Possible error codes are listed on [[API error codes]].