Ryzom API/Gilde - Versionsgeschichte

Leda: /* PHP-Interface */

2023-05-27T11:24:03Z

‎PHP-Interface

Leda am 27. Mai 2023 um 11:23 Uhr

2023-05-27T11:23:25Z

Leda am 27. Mai 2023 um 11:20 Uhr

2023-05-27T11:20:51Z

Leda am 27. Mai 2023 um 10:44 Uhr

2023-05-27T10:44:51Z

Leda: Die Seite wurde neu angelegt: „{{Trad|DE=Ryzom API/Gilde|EN=Ryzom API/Guild|palette=api|H=1}} Access to guild information. === Usage === /guild.php?apikey…“

2023-05-27T10:43:18Z

Die Seite wurde neu angelegt: „<noinclude>{{Trad|DE=Ryzom API/Gilde|EN=Ryzom API/Guild|palette=api|H=1}}</noinclude> Access to guild information. === Usage === <base URL>/guild.php?apikey…“

Neue Seite

<noinclude>{{Trad|DE=Ryzom API/Gilde|EN=Ryzom API/Guild|palette=api|H=1}}</noinclude>
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 "Gilden-API-Schlüssel '{$apikey}' gescheitert: {$code}:{$error}";
} else {
$name = htmlspecialchars($guild->name);
echo "Gilden-Name: {$name}";
}
}

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

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

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

@@ Zeile 1: / Zeile 1: @@
 <noinclude>{{Trad|DE=Ryzom API/Gilde|EN=Ryzom API/Guild|palette=api|H=1}}</noinclude>
 Zugang zu Gilden-Informationen.
 === Verwendung ===
@@ Zeile 35: / Zeile 34: @@
 === PHP-Interface ===
   ryzom_guild_api($apikey)

@@ Zeile 73: / Zeile 73: @@
    echo "Gilden-API gescheitert";
 }</syntaxhighlight>
 <noinclude>[[Kategorie:Ryzom API]]</noinclude>

@@ Zeile 8: / Zeile 8: @@
 ==== URL-Parameter ====
 ;apikey :
 :   Gilden-API-Schlüssel beginnt mit 'g'
-==== Cache Duration ====
+==== Cache-Laufzeit ====
-Guild xml element has attributes created and cached_until (utc timestamp)
+Das Guild-Xml-Element hat die Attribute created und cached_until (utc timestamp)
-API is able to return information for multiple guilds at once and so each <guild> element is a child of <ryzomapi> root elements
+==== XML-Struktur ====
 :<syntaxhighlight lang="xml"><ryzomapi>
@@ Zeile 28: / Zeile 26: @@
 </ryzomapi></syntaxhighlight>
-Invalid key error:
+Fehler bei ungültigem Schlüssel:
 <syntaxhighlight lang="xml"><guild apikey="key1" created="1387369873">
-   <error code="404">invalid key</error>
+   <error code="404">ungültiger Schlüssel</error>
 </guild></syntaxhighlight>
-Possible error codes are listed on [[Ryzom API#API error codes|API error codes]].
+Mögliche Fehlercodes sind auf [[Ryzom API#API-Fehlercodes|API-Fehlercodes]] aufgelistet.
-=== PHP interface ===
+=== PHP-Interface ===
   ryzom_guild_api($apikey)
-$apikey can be either a string or array of strings
+$apikey kann entweder ein String oder ein Array von Strings sein
-Function will return associative array of SimpleXMLElement with $apikey as array index
+Funktion gibt assoziatives Array von SimpleXMLElement mit $apikey als Array-Index zurück
-On failure function returns boolean false
+Bei Fehlschlag gibt die Funktion den booleschen Wert false zurück
 :<syntaxhighlight lang="php"><?php