Ryzom API/Character - Revision history

Leda at 09:32, 27 May 2023

2023-05-27T09:32:31Z

Leda at 09:32, 27 May 2023

2023-05-27T09:32:07Z

Dorothée at 05:48, 23 July 2020

2020-07-23T05:48:37Z

Dorothée: /* PHP interface */

2020-07-22T18:55:50Z

‎PHP interface

Dorothée: /* Usage */

2020-07-22T18:54:11Z

‎Usage

Dorothée: page layout

2020-07-22T18:53:24Z

page layout

Dorothée at 17:01, 22 July 2020

2020-07-22T17:01:06Z

Dorothée: Created page with " Character Access character information. Base URL /character.php?apikey=key /character.php?apikey[]=key1&apikey[]=key2 URL Parameters apikey Character API key..."

2020-07-22T16:57:23Z

Created page with " Character Access character information. Base URL /character.php?apikey=key /character.php?apikey[]=key1&apikey[]=key2 URL Parameters apikey Character API key..."

New page

Character

Access character information.
Base URL

/character.php?apikey=key
/character.php?apikey[]=key1&apikey[]=key2

URL Parameters

apikey
Character API key starting with 'c'

Cache Duration

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

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

<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>

Invalid key error

<character apikey="key1" created="1387369873">
<error code="404">invalid key</error>
</character>

Possible error codes are listed on API error codes.
PHP interface

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.

<?php
require_once "ryzomapi_lite.php";

function info($char) {
if (isset($char->error)) {
$apikey = htmlspecialchars($char['apikey']);
$error = htmlspecialchars($char->error);
$code = (int)$char->error['code'];
echo "Character API key '{$apikey}' failed: {$code}:{$error}";
} else {
$name = htmlspecialchars($char->name);
echo "Character name: {$name}";
}
}

$apikey = 'cABCDEF';
$chars = ryzom_character_api($apikey);
if ($chars !== false) {
info($chars[$apikey]);
} else {
echo "Character API failed";
}

$apikeys = ['cABCDEF', 'c123456'];
$chars = ryzom_character_api($apikeys);
if ($chars !== false) {
foreach($chars as $char) {
info($char);
}
} else {
echo "Character API failed";
}

<noinclude>[[Category:Ryzom API]]</noinclude>

← Older revision		Revision as of 09:32, 27 May 2023
Line 1:		Line 1:
−	<noinclude>{{Trad\|DE=Ryzom API/~~Character~~\|EN=Ryzom API/Character\|palette=api \|H=1}}</noinclude>	+	<noinclude>{{Trad\|DE=Ryzom API/Charakter\|EN=Ryzom API/Character\|palette=api \|H=1}}</noinclude>
	Access character information.		Access character information.

← Older revision		Revision as of 09:32, 27 May 2023
Line 1:		Line 1:
		+	<noinclude>{{Trad\|DE=Ryzom API/Character\|EN=Ryzom API/Character\|palette=api \|H=1}}</noinclude>
	Access character information.		Access character information.

@@ Line 70: / Line 70: @@
    echo "Character API failed";
 }</syntaxhighlight>
 <noinclude>[[Category:Ryzom API|Character]]</noinclude>

@@ Line 38: / Line 38: @@
 :On failure, function returns boolean false.
-<?php
+:<syntaxhighlight lang="php"><?php
-require_once "ryzomapi_lite.php";
+require_once "ryzomapi_lite.php";</syntaxhighlight>
 :<syntaxhighlight lang="php">function info($char) {
@@ Line 51: / Line 51: @@
      echo "Character name: {$name}";
+   }
-}:</syntaxhighlight>
+}</syntaxhighlight>
 :<syntaxhighlight lang="php">$apikey = 'cABCDEF';

@@ Line 3: / Line 3: @@
 ===Usage===
   <base URL>/character.php?apikey=key
-  <base URL> /character.php?apikey[=key1&apikey[]=key2
+  <base URL>/character.php?apikey[=key1&apikey[]=key2
 ====URL Parameters====

@@ Line 1: / Line 1: @@
 Access character information.
-apikey
+===Usage===
-    Character API key starting with 'c'
+ <base URL>/character.php?apikey=key
-Cache Duration
+====URL Parameters====
 <character> xml element has attributes *created* and *cached_until* (utc timestamp)
-API is able to return information about multiple characters at once and so each <character> element is child of <ryzomapi> root element
+==== XML structure ====
-<ryzomapi>
+API is able to return information about multiple characters at once and so each <character> element is child of <ryzomapi> root element:
    <character apikey="key1" created="1387369332" modules="C01:P01" cached_until="1387369632">
      ....
@@ Line 27: / Line 22: @@
      ....
    </character>
-</ryzomapi>
+</ryzomapi></syntaxhighlight>
-−
+Invalid key error:
-Invalid key error
+:<syntaxhighlight lang="xml"><character apikey="key1" created="1387369873">
    <error code="404">invalid key</error>
-</character>
+</character></syntaxhighlight>
+Possible error codes are listed on [[Ryzom API#API error codes|API error codes]].
-$apikey can be either string (single key) or array of strings.
+=== PHP interface ===
-On success, function returns associative array of SimpleXMLElement with apikey as array index.
+ ryzom_character_api($apikey)
-On failure, function returns boolean false.
+::$apikey can be either string (single key) or array of strings.
 <?php
 require_once "ryzomapi_lite.php";
-function info($char) {
+:<syntaxhighlight lang="php">function info($char) {
    if (isset($char->error)) {
      $apikey = htmlspecialchars($char['apikey']);
@@ Line 61: / Line 51: @@
      echo "Character name: {$name}";
+   }
+}:</syntaxhighlight>
-$apikey = 'cABCDEF';
+:<syntaxhighlight lang="php">$apikey = 'cABCDEF';
 $chars = ryzom_character_api($apikey);
 if ($chars !== false) {
@@ Line 69: / Line 59: @@
 } else {
    echo "Character API failed";
+}</syntaxhighlight>
-$apikeys = ['cABCDEF', 'c123456'];
+:<syntaxhighlight lang="php">$apikeys = ['cABCDEF', 'c123456'];
 $chars = ryzom_character_api($apikeys);
 if ($chars !== false) {
@@ Line 79: / Line 69: @@
 } else {
    echo "Character API failed";
+}</syntaxhighlight>
 <noinclude>[[Category:Ryzom API|Character]]</noinclude>

← Older revision		Revision as of 17:01, 22 July 2020
Line 82:		Line 82:


−	<noinclude>[[Category:Ryzom API]]</noinclude>	+	<noinclude>[[Category:Ryzom API\|Character]]</noinclude>