HomePage
Version 39 (kervala, 10/09/2012 09:07 am) → Version 40/45 (nimetu, 12/18/2013 01:03 pm)
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/guild 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.
h2. 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":http://app.ryzom.com/app_ryzomapi
To generate or view guild keys, you need to be guild leader or high officer.
h2. Available Ryzom API
* *[[App]]*: Create Ryzom applications that will be available out the game (with the browser) and in game.
h3. XML sources
* *[[Status]]*: To know if the game servers are open or closed.
* *[[Time]]*: To know the time and date in Ryzom. *updated for new server*
* *[[Guilds]]*: *[[Character]]*: To access character profiles.
* *[[ItemIcon]]*: To display the list icon of all guilds. an item.
* *[[Guild]]*: *[[Title]]*: To access guild information. convert a character title identifier to a translated string.
* *[[Character]]*: To access character profiles.
h3. Tools
* *[[Render]]*: PHP functions to render a webpage with Ryzom style.
* *[[ItemIcon]]*: *[[ReleaseNotes]]*: To display see the icon of an item. 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...]]
Sources and example can be found from "ryzomapi_lite":https://bitbucket.org/nimetu/ryzomapi_lite/ repository.
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|"GR105907534RCAE76F8F":http://atys.ryzom.com/api/example_profile.php?ckey=S6fMSv7-_v7jhD6N98QxUr8XRwbR7FYF8AW6bg|
|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://app.ryzom.com/app_forum/index.php?page=topic/view/18541 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*
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/guild 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.
h2. 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":http://app.ryzom.com/app_ryzomapi
To generate or view guild keys, you need to be guild leader or high officer.
h2. Available Ryzom API
* *[[App]]*: Create Ryzom applications that will be available out the game (with the browser) and in game.
h3. XML sources
* *[[Status]]*: To know if the game servers are open or closed.
* *[[Time]]*: To know the time and date in Ryzom. *updated for new server*
* *[[Guilds]]*: *[[Character]]*: To access character profiles.
* *[[ItemIcon]]*: To display the list icon of all guilds. an item.
* *[[Guild]]*: *[[Title]]*: To access guild information. convert a character title identifier to a translated string.
* *[[Character]]*: To access character profiles.
h3. Tools
* *[[Render]]*: PHP functions to render a webpage with Ryzom style.
* *[[ItemIcon]]*: *[[ReleaseNotes]]*: To display see the icon of an item. 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...]]
Sources and example can be found from "ryzomapi_lite":https://bitbucket.org/nimetu/ryzomapi_lite/ repository.
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|"GR105907534RCAE76F8F":http://atys.ryzom.com/api/example_profile.php?ckey=S6fMSv7-_v7jhD6N98QxUr8XRwbR7FYF8AW6bg|
|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://app.ryzom.com/app_forum/index.php?page=topic/view/18541 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*