Diferencia entre revisiones de «Ryzom API»

De EnciclopAtys

Saltar a: navegación, buscar
Línea 17: Línea 17:
 
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>'''.
 
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=
+
==Fundamentos==
== Base URL ==
+
=== URL de base ===
All requests are using '''<code><nowiki>https://api.ryzom.com</nowiki></code>''' as base url.
+
Todas las consultas están usando '''<code><nowiki>https://api.ryzom.com</nowiki></code>''' como radical del URL.
  
== API keys ==
+
=== Claves API ===
*API keys are 41 alphanumeric characters. Character keys start with 'c' and guild keys with 'g'.
+
*Las claves API son 41 caracteres alfanuméricos. Los personajes comienzan con 'c' y los gremio con '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>
+
*Las claves API deben crearse usando "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.
+
*Debes ser líder del gremio o alto oficial para administrar y ver la clave API del gremio.
  
== PHP API ==
+
=== PHP API ===
 
[[:wikipedia:PHP|PHP]] API library can be found in the [https://bitbucket.org/nimetu/ryzomapi_lite/src/default/ ryzomapi_lite] repository.
 
[[:wikipedia:PHP|PHP]] API library can be found in the [https://bitbucket.org/nimetu/ryzomapi_lite/src/default/ ryzomapi_lite] repository.
  
== Third party libraries ==
+
=== 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.
 
([[: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 ?==
+
=== python Interface ?===
=Functions=
+
==Functions==
==[[Ryzom API/Time|Time]]==
+
===[[Ryzom API/Time|Time]]===
 
{{/Time}}
 
{{/Time}}
  
==[[Ryzom API/Character|Character]]==
+
===[[Ryzom API/Character|Character]]===
 
{{/Character}}
 
{{/Character}}
  
==[[Ryzom API/Guilds|Guilds]]==
+
===[[Ryzom API/Guilds|Guilds]]===
 
{{/Guilds}}
 
{{/Guilds}}
  
==[[Ryzom API/Guild|Guild]]==
+
===[[Ryzom API/Guild|Guild]]===
 
{{/Guild}}
 
{{/Guild}}
  
== API error codes ==
+
=== API error codes ===
  
 
;404 invalid api key :  
 
;404 invalid api key :  
Línea 58: Línea 58:
 
----
 
----
  
=Tools=
+
==Tools==
  
== [[Ryzom API/Render|Render]] ==
+
=== [[Ryzom API/Render|Render]] ===
 
{{/Render}}
 
{{/Render}}
  
== [[Ryzom API/Guild icon|Guild icon]] ==
+
=== [[Ryzom API/Guild icon|Guild icon]] ===
 
{{/Guild icon}}
 
{{/Guild icon}}
  
== [[Ryzom API/Item icon|Item icon]] ==
+
=== [[Ryzom API/Item icon|Item icon]] ===
 
{{/Item icon}}
 
{{/Item icon}}
 
----
 
----
  
=In Game=
+
==In Game==
== [[Ryzom API/AppZone|AppZone]] ==
+
=== [[Ryzom API/AppZone|AppZone]] ===
 
{{/AppZone}}
 
{{/AppZone}}
  
== In-game browser ==
+
=== In-game browser ===
  
 
----
 
----
=WikipAtys=
+
==WikipAtys==
==Wiki implemetation==
+
===Wiki implemetation===
 
Pages in [[:Category:API templates|Category : "API templates]]" :
 
Pages in [[:Category:API templates|Category : "API templates]]" :
 
{{#dpl:
 
{{#dpl:
Línea 87: Línea 87:
 
: 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]].
 
: 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 ===
+
==== Examples ====
 
*[[Crafting/Crafting Part Table]]
 
*[[Crafting/Crafting Part Table]]
 
*[[Template:APIitemIcon]] (documentation examples)
 
*[[Template:APIitemIcon]] (documentation examples)
  
=Links=
+
==Links==
 
*API Documentation (sources):
 
*API Documentation (sources):
 
**➡ https://api.ryzom.com/
 
**➡ https://api.ryzom.com/

Revisión del 20:34 13 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 13.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 wikipedia:es: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 el enmascaramiento 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.


Fundamentos

URL de base

Todas las consultas están usando https://api.ryzom.com como radical del URL.

Claves API

  • Las claves API son 41 caracteres alfanuméricos. Los personajes comienzan con 'c' y los gremio con 'g'.
  • Las claves API deben crearse usando "RyzomAPI app": https://app.ryzom.com/app_ryzomapi
  • Debes ser líder del gremio o alto oficial para administrar y ver la clave API del gremio.

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•