HomePage

Version 34 (vl, 07/21/2009 08:42 am) → Version 35/45 (vl, 07/21/2009 10:19 am)

h2. Welcome to the Ryzom API Wiki.

You'll find here the documentation about Ryzom API.

Ryzom API is an URL based system to get some Ryzom information like server status, game time or character profile.

*Note*: Ryzom API is currently in *Beta test*. It means that it's possible we'll change the API, the XML format, the API keys format in the near future.

*IMPORTANT: The Ryzom Coding Contest is open! [[Contest|Read more information]]*

h2. Available Ryzom API

* *[[Status]]*: To know if the game servers are open or closed.
* *[[Time]]*: To know the time and date in Ryzom
* *[[Character]]*: To access character profiles.
* *[[ItemIcon]]*: To display the icon of an item.
* *[[Title]]*: To convert a character title identifier to a translated string.
* *[[Render]]*: PHP functions to render a webpage with Ryzom style.
* *[[ReleaseNotes]]*: To see the patch release notes.
* *[[GuildIcon]]*: To display the icon of a guild.
* *[[Guilds]]*: To display the list of all guilds.
* *[[Guild]]*: To access guild information.

h2. User Tools

* *[[Banner]]*: Display the banner of a character.
* *[[ExampleProfile]]*: Display a basic character profile.

h2. PHP API

We developed a set of helper function in PHP to easier access the Ryzom API. [[PHP Ryzom API|More information...]]

h3. What's new in the API?

You can see the changes made in the api on [[Changelog|this page]].

h2. Testing Characters

We setuped 2 testing characters and 1 guild so everyone can use these key to test their application.

|_.Character Name|_.Partial Character Key|_.Full Character Key|_.Guild Key|
|Apihomin|PR521366R0R343D6080|"FR521366R0REA16F998":http://atys.ryzom.com/api/example_profile.php?ckey=B65hSjw8PDxcfcyUZ6wFl87tkLcFTIsILgub|"GR105907534R7DEDCDA7":http://atys.ryzom.com/api/example_profile.php?ckey=Ka5hSuzs7Oyz8E6kRPkIFJcu6BO1knPa0_42ig|
|Apinoob|PR521366R1R2DDE4B93|"FR521366R1R05EF0010":http://atys.ryzom.com/api/example_profile.php?ckey=HK5hSjs7OzsQAz18CJeERjWAzxqzUU_0u9mN||

h2. Discuss

You want to discuss about Ryzom API? You have the choice:

h3. Forums

If you have some ideas of a website that could be fun that use Ryzom API, post it on "the forum":http://dev.ryzom.com/projects/ryzom-api/boards/11

There are other forums to talk about different subjects "here":http://dev.ryzom.com/projects/ryzom-api/boards

h3. Chat

Chat with us about Ryzom API on IRC: *irc.freenode.net / #ryzom*