Version vom 24. Mai 2022, 04:04 Uhr

 !!!! WIP !!!!

Es sind gerade 26 Artikel in der Bearbeitung in der Kategorie "WIP"

Dieser Artikel wird gerade bearbeitet. Bitte laß es den Autor beenden, bevor du es veränderst.
Die letzte Bearbeitung war von Leda am 24.05.2022.

---

• • •

 

Übersetzung zur Überprüfung

Gib nicht den Mitwirkenden die Schuld, sondern komm und hilf ihnen. 😎

Diese Seite ist die Ryzom Forge-Version der api.ryzom.com-Seite.

Laut Wikipedia ist eine API oder "Anwendungsprogrammierschnittstelle" eine Computerschnittstelle, die Interaktionen zwischen mehreren Softwarevermittlern definiert. Sie definiert die Arten von Aufrufen oder Anfragen, die gemacht werden können, wie sie gemacht werden können, die Datenformate, die verwendet werden sollten, die zu befolgenden Konventionen, usw. [...]Durch das Verstecken von Informationen ermöglichen APIs eine modulare Programmierung, die es den Benutzern ermöglicht, die Schnittstelle unabhängig von der Implementierung zu nutzen.

In unserem Fall ist Ryzom API ein URL-basiertes System, um einige Ryzom in-game Informationen wie Spielzeit, Charakter, Gildenprofil... zu erhalten. Das API-Änderungsprotokoll kann gefunden werden unter forum.

Grundlagen

Basis-URL

Alle Anfragen verwenden https://api.ryzom.com als Basis-URL.

API Schlüssel

• API-Schlüssel bestehen aus 41 alphanumerischen Zeichen. Charakterschlüssel beginnen mit 'c' und Gildenschlüssel mit 'g'.
• API-Schlüssel müssen mit "RyzomAPI app" erstellt werden: https://app.ryzom.com/app_ryzomapi
• Sie müssen Gildenleiter oder hoher Offizier sein, um den Api-Schlüssel der Gilde zu verwalten und einzusehen.

PHP API

Die PHP-API-Bibliothek befindet sich im ryzom API client-Repository.

Bibliotheken von Drittanbietern

(PHP) Übersetzungen der Blätter und Informationen über Ressourcen finden Sie in der https://github.com/nimetu/ryzom_extra Repository. Der json-resources Zweig hat Daten im Format JSON.

Python-Interface ?

Funktionen

Time

Um die Uhrzeit und das Datum in Ryzom zu erfahren.

Verwendung

<base URL>/time.php

URL-Parameter

Format

(optional), Standardwerte roh.

• raw : Gibt den Tick zurück. Der Tick des Servers ist eine 32-Bit-Ganzzahl, die alle 100 Millisekunden um eins erhöht wird.
• txt : Gibt eine für Homin lesbare Zeichenkette zurück.
• xml : Gibt eine xml-Datei zurück, die alle Shard-Zeitinformationen enthält.

Cache-Dauer

Die Daten werden für 1 Minute zwischengespeichert.

XML structure

<shard_time>
  <server_tick>514105152</server_tick>
  <jena_year>2576</jena_year>
  <day_of_jy>319</day_of_jy>
  <month_of_jy>10</month_of_jy>
  <cycle>0</cycle>
  <day_of_cycle>319</day_of_cycle>
  <month_of_cycle>10</month_of_cycle>
  <day_of_month>19</day_of_month>
  <day_of_week>1</day_of_week>
  <season>3</season>
  <day_of_season>49</day_of_season>
  <time_of_day>13</time_of_day>
  <txt_en>13h - Dua, Mystia 20, 1st AC 2576</txt_en>
  <txt_fr>13h - Dua, Mystia 20, 1er CA 2576</txt_fr>
  <txt_de>13h - Dua, Mystia 20, 1. AZ 2576</txt_de>
  <cache created="1387437183" expire="1387437243"/>
</shard_time>

PHP-Interface

ryzom_time_api() : Gibt SimpleXMLElement oder boolesches false bei Fehlschlag zurück.

<?php
  require_once "ryzomapi_lite.php";

  $time = ryzom_time_api('xml');
  if ($time !== false) {
    $txt_en = htmlspecialchars($time->txt_en);
    echo "Atys time is {$txt_en}";
  } else {
    echo "API failure";
  }
?>

Character

Ryzom API/Character

Guilds

Ryzom API/Guilds

Guild

Ryzom API/Guild

API error codes

404 invalid api key 

No such API key.

403 key expired 

API key is valid, but has expired

503 character data is not initialized

503 guild data is not initialized

Temporary server side error indicating that character/guild info is currently not available.

Data will be available after character has logged in to game

Tools

Render

Dies ist ein Satz von PHP-Funktionen zum Rendern einer Webseite im Ryzom-Stil.

CSS-Datei

Sie müssen die Ryzom-css-Datei manuell einbinden:

<link href="https://api.ryzom.com/data/css/ryzom_ui.css" rel="stylesheet" media="all">

PHP-Interface

ryzom_render_window($title, $content, array $links)

Gibt HTML-Markup zurück, das dem Stil des Ingame-Fensters ähnelt

$title

$content

$links - (optional) assoziatives Array, das die Schaltflächen auf der rechten Seite der Titelleiste des Fensters definiert

<?php
require_once "ryzomapi_lite.php";

$links = array(
  array('href' => 'http://www.ryzom.com/', 'text' => 'Ryzom-Webseite'),
  array('href' => 'http://app.ryzom.com/app_ryzomapi/', 'text' => 'RyzomAPI-App'),
);

echo ryzom_render_window('Title', 'Hallo Welt!', $links);

Guild icon

Ryzom API/Guild icon

Item icon

Ryzom API/Item icon

In Game

AppZone

Benutzerauthentifizierung für in AppZone registrierte Anwendungen

Verwendung

URL-Werte

user -- base64 kodiertes php serialisiertes Array

checksum -- sha1 hash_hmac mit geheimem App-Schlüssel aus AppZone

Aufgrund von php serialize muss die Prüfsumme validiert werden, bevor der Benutzerwert sicher verwendet werden kann.
Eine validierende Prüfsumme bietet auch eine starke Garantie dafür, daß der Benutzer derjenige ist, der er vorgibt zu sein.

Beispiel, wie die Rückmeldung erstellt wird:

$userArray = [
  'timestamp' => "0.9696200 1503915319",
  'app_url' => 'http://...',
  'id' => "1",
  'char_name' => 'Spieler',
  'race' => 'Tryker',
  'cult' => 'Neutral',
  'civ' => 'Neutral',
  'organization' => 'Marodeur',
  'guild_id' => '105906000',
  'guild_icon' => '17',
  'guild_name' => 'Gilde',
  'grade' => 'Anführer',
  'lang' => 'de'
];

$user = base64_encode(serialize($userArray));
$checksum = hash_hmac('sha1', $user, $appKey);

timestamp enthält Mikrosekunden und Sekunden, in denen die Antwort erstellt wurde, und sollte überprüft werden, um zu verhindern, dass dieselbe Antwort mehrfach wiedergegeben wird.
app_url muss aktiviert werden, um zu verhindern, dass dieselbe AppZone-Antwort in anderen Anwendungen verwendet wird.

PHP-Interface

ryzom_app_authenticate(&$user)

Diese Funktion überprüft die AppZone-Benutzer- und -Prüfsummen-URL-Parameter. Verwendet $_GET['user'] und $_GET['checksum'] direkt.
Die Funktion gibt bei Erfolg den booleschen Wert true zurück. Die Variable $user enthält Informationen von AppZone oder eine Fehlermeldung, wenn ein Fehler aufgetreten ist.

$_SESSION['app.user']

Konstanten welche definiert sein sollten :

RYAPI_AUTH_KEY

geheimer Schlüssel in der AppZone

wenn leer, dann werden die Benutzerdaten nicht überprüft (nicht empfohlen)

RYAPI_APP_URL

App-Url in der AppZone

wenn leer, dann wird automatisch die am besten ermittelte Url verwendet

wenn false, dann wird die Anwendungs-Url nicht verifiziert

RYAPI_APP_MAXAGE

Höchstalter in Sekunden für die Gültigkeit der AppZone-Url

wenn 0, wird der Zeitstempel (timestamp) nicht verifiziert

<?php
  require_once "ryzomapi_lite.php";

  define('RYAPI_AUTH_KEY', 'secret-key');
  define('RYAPI_APP_URL', 'http://app.url/');
  define('RYAPI_APP_MAXAGE', 30);

  session_start();

  $user = false;
  if (ryzom_app_authenticate($user)) {
    $charName = htmlspecialchars($user['char_name']);
    echo "Hallo {$charName}!";
  } else {
    $error = htmlspecialchars($user);
    echo "Autentifizierungs-Fehler ({$error}).";
  }

In-game browser

WikipAtys

Wiki implemetation

Pages in Category : "API templates" :

Extension:DynamicPageList (DPL), version 3.1.1: Warnung: Kein passender Eintrag gefunden!

⚠Warning

The code required to retrieve icons is raw html. You won't be able to format pictures as "easily" as when you use wiki code and the image is stored on Atys commons.

Examples

• Crafting/Crafting Part Table
• Template:APIitemIcon (documentation examples)

Links

• API Documentation (sources):
  • ➡ https://api.ryzom.com/
  • ⛔ http://dev.ryzom.com/projects/ryzom-api/wiki (registered developers, 🔑 password required)
• Example page and php library sources : https://bitbucket.org/nimetu/ryzomapi_lite
• Live working example page (Ballistic Mystix) : http://ryapp.bmsite.net/
• API discussion in forum : http://app.ryzom.com/app_forum/index.php?page=topic/view/18541
• the App (Appzone) Api key to create and get a key: https://app.ryzom.com/app_ryzomapi/index.php?

Ergänzungen zu dieser Seite:

Portal der Forge von Ryzom