View source for Ryzom API

<noinclude>{{Trad
|DE = Ryzom API |DEs= 
|EN = Ryzom API |ENs= 0
|ES = Ryzom API |ESs= 2
|FR = Ryzom API |FRs= 
|RU = Ryzom API |RUs= 
|H  = 1
|palette= 
|ref= 
|com= 
}}{{Clear}}<div style = "float:right;"> <small>__TOC__</small></div></noinclude>
<br />
<br />
<br />

This page is the [[Portal:Forge|Ryzom Forge]] version of <span class="plainlinks">[https://api.ryzom.com/ api.ryzom.com]</span> site

According to [[:wikipedia:Application programming interface|Wikipedia]], an  API or "''Application Programming interface''"  is a computing interface which defines interactions between multiple software intermediaries. It defines the kinds of calls or requests that can be made, how to make them, the data formats that should be used, the conventions to follow, etc. [...]Through information hiding, APIs enable modular programming, which allows users to use the interface independently of the implementation. 

In our case: [[Ryzom API]] is an URL based system to get some Ryzom ''in-game information'' like game time, character, guild profile...
API changes log can be found on '''<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://gitlab.com/ryzom/web/ryzom-api-client ryzom API client] repository.

== Third party libraries ==
([[:wikipedia:PHP|PHP]]) Sheet translations and info about resources can be found in 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><br />
<br />
{{clear}}
{{Reflist|subpages=1}}{{Portal|Forge}}
[[Category:Ryzom API]]  [[Category:Tutorials]] [[Category:Reference Guides]]
[[de:Ryzom API]] [[en:Ryzom API]] [[es:Ryzom API]] [[fr:Ryzom API]] [[ru:Ryzom API]]  <!-- for Interlanguage  menu-->{{last version link|Ryzom API}}</noinclude>