HomePage
Version 40 (nimetu, 12/18/2013 01:03 pm)
| 1 | 30 | vl | h2. Welcome to the Ryzom API Wiki. |
|---|---|---|---|
| 2 | 1 | vl | |
| 3 | 15 | vl | You'll find here the documentation about Ryzom API. |
| 4 | 1 | vl | |
| 5 | 40 | nimetu | Ryzom API is an URL based system to get some Ryzom information like game time or character/guild profile. |
| 6 | 12 | vl | |
| 7 | 29 | vl | *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. |
| 8 | 1 | vl | |
| 9 | 40 | nimetu | h2. New API keys |
| 10 | 40 | nimetu | |
| 11 | 40 | nimetu | New API keys are 41 alphanumeric characters. Character keys start with 'c' and guild keys with 'g'. |
| 12 | 40 | nimetu | |
| 13 | 40 | nimetu | API keys can be created using "RyzomAPI app":http://app.ryzom.com/app_ryzomapi |
| 14 | 40 | nimetu | |
| 15 | 40 | nimetu | To generate or view guild keys, you need to be guild leader or high officer. |
| 16 | 40 | nimetu | |
| 17 | 21 | zorglub | h2. Available Ryzom API |
| 18 | 1 | vl | |
| 19 | 1 | vl | * *[[App]]*: Create Ryzom applications that will be available out the game (with the browser) and in game. |
| 20 | 40 | nimetu | |
| 21 | 40 | nimetu | h3. XML sources |
| 22 | 40 | nimetu | |
| 23 | 1 | vl | * *[[Time]]*: To know the time and date in Ryzom. *updated for new server* |
| 24 | 40 | nimetu | * *[[Guilds]]*: To display the list of all guilds. |
| 25 | 40 | nimetu | * *[[Guild]]*: To access guild information. |
| 26 | 1 | vl | * *[[Character]]*: To access character profiles. |
| 27 | 40 | nimetu | |
| 28 | 40 | nimetu | h3. Tools |
| 29 | 40 | nimetu | |
| 30 | 18 | vl | * *[[Render]]*: PHP functions to render a webpage with Ryzom style. |
| 31 | 40 | nimetu | * *[[ItemIcon]]*: To display the icon of an item. |
| 32 | 1 | vl | * *[[GuildIcon]]*: To display the icon of a guild. |
| 33 | 1 | vl | |
| 34 | 1 | vl | h2. User Tools |
| 35 | 35 | vl | |
| 36 | 33 | vl | * *[[ExampleProfile]]*: Display a basic character profile. |
| 37 | 32 | vl | |
| 38 | 32 | vl | h2. PHP API |
| 39 | 32 | vl | |
| 40 | 40 | nimetu | We developed a set of helper function in PHP to easier access the Ryzom API. |
| 41 | 36 | vl | |
| 42 | 40 | nimetu | Sources and example can be found from "ryzomapi_lite":https://bitbucket.org/nimetu/ryzomapi_lite/ repository. |
| 43 | 40 | nimetu | |
| 44 | 4 | vl | h3. What's new in the API? |
| 45 | 9 | vl | |
| 46 | 15 | vl | You can see the changes made in the api on [[Changelog|this page]]. |
| 47 | 15 | vl | |
| 48 | 10 | vl | h2. Discuss |
| 49 | 10 | vl | |
| 50 | 15 | vl | You want to discuss about Ryzom API? You have the choice: |
| 51 | 10 | vl | |
| 52 | 14 | vl | h3. Forums |
| 53 | 10 | vl | |
| 54 | 40 | nimetu | 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 |
| 55 | 1 | vl | |
| 56 | 23 | vl | h3. Chat |
| 57 | 1 | vl | |
| 58 | 1 | vl | Chat with us about Ryzom API on IRC: *irc.freenode.net / #ryzom* |