Ryzom API

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 game time or character/guild 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.

New API keys¶

New API keys are 41 alphanumeric characters. Character keys start with 'c' and guild keys with 'g'.

API keys can be created using RyzomAPI app

To generate or view guild keys, you need to be guild leader or high officer.

Available Ryzom API¶

• App: Create Ryzom applications that will be available out the game (with the browser) and in game.

XML sources¶

• Time: To know the time and date in Ryzom. updated for new server
• Guilds: To display the list of all guilds.
• Guild: To access guild information.
• Character: To access character profiles.

Tools¶

• Render: PHP functions to render a webpage with Ryzom style.
• ItemIcon: To display the icon of an item.
• GuildIcon: To display the icon of a guild.

User Tools¶

• ExampleProfile: Display a basic character profile.

PHP API¶

We developed a set of helper function in PHP to easier access the Ryzom API.

Sources and example can be found from ryzomapi_lite repository.

What's new in the API?¶

You can see the changes made in the api on this page.

Discuss¶

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

Forums¶

If you have some ideas of a website that could be fun that use Ryzom API, post it on the forum

Chat¶

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