Character
Version 11 (vl, 04/24/2009 02:58 pm) → Version 12/18 (kishan, 04/24/2009 04:16 pm)
h1. Character
Access information from a character.
h2. Base URL
* http://atys.ryzom.com/api/character.php
h2. URL Parameters
h3. @key@
The [[API Key]] of the character (partial or full)
h3. @part@ (optional)
The part you want to retrieve.
Default value depends of the key. If you provide a partial key, @part@ will be @partial@. If you provide a full key, @part@ will be @full@.
Of course, you can not cannot access the full profile with a partial key.
* @partial@: Get basics information (mainly public information, smaller file).
* @full@: Get all information (bigger file, use it only if you really need specific information that exists only in this profile).
* @items@: Get items information related to the character.
h2. Cache Duration
The profile is cached for *1 hour*.
h2. PHP Interface
h3. @ryzom_character_simplexml($key, $part='')@
Get a @$key@ (partial or full) and a @$part@ and returns a "simplexml":http://fr3.php.net/manual/en/book.simplexml.php object containing the character information.
h3. @ryzom_character_valid_key($key, &$uid, &$slot, &$full)@
Returns true if the key seems valid (or false if not). It doesn't do server check, but only basic checks.
This function sets set the user id and slot for this key. @$full@ will be @true@ if the key give full access to the character.
h2. Real Examples
If you have a website that use this Ryzom API, tell it in the forum and we'll add it.
Access information from a character.
h2. Base URL
* http://atys.ryzom.com/api/character.php
h2. URL Parameters
h3. @key@
The [[API Key]] of the character (partial or full)
h3. @part@ (optional)
The part you want to retrieve.
Default value depends of the key. If you provide a partial key, @part@ will be @partial@. If you provide a full key, @part@ will be @full@.
Of course, you can not cannot access the full profile with a partial key.
* @partial@: Get basics information (mainly public information, smaller file).
* @full@: Get all information (bigger file, use it only if you really need specific information that exists only in this profile).
* @items@: Get items information related to the character.
h2. Cache Duration
The profile is cached for *1 hour*.
h2. PHP Interface
h3. @ryzom_character_simplexml($key, $part='')@
Get a @$key@ (partial or full) and a @$part@ and returns a "simplexml":http://fr3.php.net/manual/en/book.simplexml.php object containing the character information.
h3. @ryzom_character_valid_key($key, &$uid, &$slot, &$full)@
Returns true if the key seems valid (or false if not). It doesn't do server check, but only basic checks.
This function sets set the user id and slot for this key. @$full@ will be @true@ if the key give full access to the character.
h2. Real Examples
If you have a website that use this Ryzom API, tell it in the forum and we'll add it.