Ryzom API/Guild - Revision history

Leda at 10:23, 27 May 2023

2023-05-27T10:23:29Z

Dorothée at 06:52, 23 July 2020

2020-07-23T06:52:11Z

Dorothée: category

2020-07-23T05:52:32Z

Dorothée: Created page with " Access to guild information. === Usage === /guild.php?apikey=key /guild.php?apikey[]=key1&apikey[]=key2 ==== URL Parameters ==== ;apikey : : Guild..."

2020-07-22T21:23:38Z

Created page with " Access to guild information. === Usage === <base URL>/guild.php?apikey=key <base URL>/guild.php?apikey[]=key1&apikey[]=key2 ==== URL Parameters ==== ;apikey : : Guild..."

New page

Access to guild information.

=== Usage ===
<base URL>/guild.php?apikey=key
<base URL>/guild.php?apikey[]=key1&apikey[]=key2

==== URL Parameters ====

;apikey :
: Guild API key starting with 'g'

==== Cache Duration ====
Guild xml element has attributes created and cached_until (utc timestamp)

==== XML structure ====

API is able to return information for multiple guilds at once and so each <guild> element is a child of <ryzomapi> root elements

:<syntaxhighlight lang="xml"><ryzomapi>
<guild apikey="key1" created"1387369332" modules="G01:G02:G03:G04:P01" cached_until="1387369632">
...
</guild>
<guild apikey="key2" created"1387369332" modules="P01" cached_until="1387369632">
...
</guild>
</ryzomapi></syntaxhighlight>

Invalid key error

<syntaxhighlight lang="xml"><guild apikey="key1" created="1387369873">
<error code="404">invalid key</error>
</guild></syntaxhighlight>

Possible error codes are listed on [[Ryzom API#API error codes|API error codes]].

=== PHP interface ===

ryzom_guild_api($apikey)

$apikey can be either a string or array of strings

Function will return associative array of SimpleXMLElement with $apikey as array index
On failure function returns boolean false

:<syntaxhighlight lang="php"><?php
require_once "ryzomapi_lite.php";

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

$apikey = 'gABCDEF';
$guilds = ryzom_guild_api($apikey);
if ($guilds !== false) {
info($guilds[$apikey]);
} else {
echo "Guild API failed";
}

$apikeys = ['gABCDEF', 'g123456'];
$guilds = ryzom_guild_api($apikeys);
if ($guilds !== false) {
foreach($guilds as $guild) {
info($guild);
}
} else {
echo "Guild API failed";
}</syntaxhighlight>

← Older revision		Revision as of 10:23, 27 May 2023
Line 1:		Line 1:
−		+	<noinclude>{{Trad\|DE=Ryzom API/Gilde\|EN=Ryzom API/Guild\|palette=api\|H=1}}</noinclude>
	Access to guild information.		Access to guild information.

@@ Line 77: / Line 77: @@
    echo "Guild API failed";
 }</syntaxhighlight>
-<noinclude>[[Category:Ryzom API|{{subst:SUBPAGENAME}] ]]</noinclude>
+<noinclude>[[Category:Ryzom API|Guild]]</noinclude>

@@ Line 28: / Line 28: @@
 </ryzomapi></syntaxhighlight>
+Invalid key error:
 <syntaxhighlight lang="xml"><guild apikey="key1" created="1387369873">
@@ Line 78: / Line 77: @@
    echo "Guild API failed";
 }</syntaxhighlight>