De EnciclopAtys
¡¡¡ Artículo en preparación !!! La última edición fue de Zorroargh el 13.08.2020
• 
Contenido
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
Character
Guilds
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
Guild icon
Item icon
In Game
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
- 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?
