Diferencia entre revisiones de «Ryzom API»

De EnciclopAtys

Saltar a: navegación, buscar
m
Línea 1: Línea 1:
{{:en:Ryzom API}}
+
{{WIP}}<noinclude>{{Trad
<noinclude>[[Categoría:Forge]][[Category:Ryzom API]] </noinclude>
+
|DE = Ryzom API |DEs=
 +
|EN = Ryzom API |ENs= 0
 +
|ES = Ryzom API |ESs=
 +
|FR = Ryzom API |FRs=
 +
|RU = Ryzom API |RUs=
 +
|H  = 1
 +
|palette=
 +
|ref=
 +
|com=
 +
}}{{Clear}}<div style = "float:right;"> <small>__TOC__</small></div></noinclude>
 +
Esta página es la versión [[Portal:Forge|Ryzom Forge]] del sitio <span class="plainlinks">[https://api.ryzom.com/ api.ryzom.com]</span>.
 +
 
 +
De acuerdo a [[:wikipedia:es:Interfaz de programación de aplicaciones|Wikipedia]], una API ( en inglés, ''application programming interface'') o interfaz de programación de aplicaciones, es una interfaz informática que define las interacciones entre varios ''software'' como una capa de abstracción. Define los tipos de llamadas o solicitudes que se pueden realizar, cómo hacerlas, los formatos de datos que se deben utilizar, las convenciones a seguir, etc. [...]A través de la ocultación de información, las API permiten la programación modular, lo que permite a los usuarios usar la interfaz independientemente de la implementación.
 +
 
 +
En nuestro caso: [[Ryzom API]] es un sistema basado en URL para obtener de Ryzom ''in-game information'' como el tiempo de juego, el perfil de personajes, de gremios...
 +
El registro de cambios de API se puede encontrar en '''<span class="plainlinks">[https://app.ryzom.com/app_forum/index.php?page=topic/view/18541 forum]</span>'''.
 +
----
 +
=Basics=
 +
== Base URL ==
 +
All requests are using '''<code><nowiki>https://api.ryzom.com</nowiki></code>''' as base url.
 +
 
 +
== API keys ==
 +
*API keys are 41 alphanumeric characters. Character keys start with 'c' and guild keys with 'g'.
 +
*API keys must be created using "RyzomAPI app": <span class="plainlinks">[https://app.ryzom.com/app_ryzomapi https://app.ryzom.com/app_ryzomapi]</span>
 +
*You must be guild leader or high officer to manage and view guild api key.
 +
 
 +
== PHP API ==
 +
[[:wikipedia:PHP|PHP]] API library can be found in the [https://bitbucket.org/nimetu/ryzomapi_lite/src/default/ ryzomapi_lite] repository.
 +
 
 +
== Third party libraries ==
 +
([[:wikipedia:PHP|PHP]]) Sheet translations and info about resources can be found from the <span class="plainlinks">[https://github.com/nimetu/ryzom_extra https://github.com/nimetu/ryzom_extra]</span> repository. The <span class="plainlinks">[https://github.com/nimetu/ryzom_extra/tree/json-resources json-resources]</span> branch has data in [[:wikipedia:JSON|JSON]] format.
 +
 
 +
== python Interface ?==
 +
=Functions=
 +
==[[Ryzom API/Time|Time]]==
 +
{{/Time}}
 +
 
 +
==[[Ryzom API/Character|Character]]==
 +
{{/Character}}
 +
 
 +
==[[Ryzom API/Guilds|Guilds]]==
 +
{{/Guilds}}
 +
 
 +
==[[Ryzom API/Guild|Guild]]==
 +
{{/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=
 +
 
 +
== [[Ryzom API/Render|Render]] ==
 +
{{/Render}}
 +
 
 +
== [[Ryzom API/Guild icon|Guild icon]] ==
 +
{{/Guild icon}}
 +
 
 +
== [[Ryzom API/Item icon|Item icon]] ==
 +
{{/Item icon}}
 +
----
 +
 
 +
=In Game=
 +
== [[Ryzom API/AppZone|AppZone]] ==
 +
{{/AppZone}}
 +
 
 +
== In-game browser ==
 +
 
 +
----
 +
=WikipAtys=
 +
==Wiki implemetation==
 +
Pages in [[:Category:API templates|Category : "API templates]]" :
 +
{{#dpl:
 +
category=API templates
 +
}}
 +
 
 +
;<big><big>⚠</big></big>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:Main Page|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?
 +
<noinclude>{{Clear}}</noinclude>
 +
----<small><references/></small>
 +
{{read more|:en:Ryzom API}}
 +
----{{Last version link|Ryzom API}}<noinclude>
 +
{{Portal|Forge}}
 +
[[Categoría:Forge]][[Category:Encyclopatys]]
 +
</noinclude>

Revisión del 17:15 12 ago 2020


Important.png
Under Construction Panel.png ¡¡¡ Artículo en preparación !!! Under Construction Panel.png
Todavía hay 19 artículos en preparación en la categoría "WIP"
Artículo en preparación. Deja que el autor lo termine antes de cambiarlo.
La última edición fue de Zorroargh el 12.08.2020

de:Ryzom API en:Ryzom API es:Ryzom API fr:Ryzom API ru:Ryzom API
 
UnderConstruction.png
¡Traducción que tiene que ser revisada!
¡No culpes a los contribuyentes, pero ayúdalos! 😎
Texto de referencia (Texto actualizado, utilizado como referencia) :
Notas :

Esta página es la versión Ryzom Forge del sitio api.ryzom.com.

De acuerdo a Wikipedia, una API ( en inglés, application programming interface) o interfaz de programación de aplicaciones, es una interfaz informática que define las interacciones entre varios software como una capa de abstracción. Define los tipos de llamadas o solicitudes que se pueden realizar, cómo hacerlas, los formatos de datos que se deben utilizar, las convenciones a seguir, etc. [...]A través de la ocultación de información, las API permiten la programación modular, lo que permite a los usuarios usar la interfaz independientemente de la implementación.

En nuestro caso: Ryzom API es un sistema basado en URL para obtener de Ryzom in-game information como el tiempo de juego, el perfil de personajes, de gremios... El registro de cambios de API se puede encontrar en forum.


Basics

Base URL

All requests are using https://api.ryzom.com as base url.

API keys

  • API keys are 41 alphanumeric characters. Character keys start with 'c' and guild keys with 'g'.
  • API keys must be created using "RyzomAPI app": https://app.ryzom.com/app_ryzomapi
  • You must be guild leader or high officer to manage and view guild api key.

PHP API

PHP API library can be found in the ryzomapi_lite repository.

Third party libraries

(PHP) Sheet translations and info about resources can be found from the https://github.com/nimetu/ryzom_extra repository. The json-resources branch has data in JSON format.

python Interface ?

Functions

Time

Ryzom API/Time

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

Ryzom API/Render

Guild icon

Ryzom API/Guild icon

Item icon

Ryzom API/Item icon


In Game

AppZone

Ryzom API/AppZone

In-game browser


WikipAtys

Wiki implemetation

Pages in Category : "API templates" :

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

Links




Última versión 2021-10-31•