Do not edit this page. It is automatically generated from "script/kids/3DMapSystemApp/MCML/readme.lua", so edit the source file instead.

ParaWorld API

What is ParaWorld API?

ParaWorld API is an evolving collection of web service or REST interface. You can add social context to your application by calling these API to access user profile, friend, photo, map, and many other official application interface.

Web serivce vs. REST Interface

API uses both web service and REST-like interface. REST interface means that all web method calls are made over the Internet by sending HTTP GET or POST requests to the our servers. Nearly any computer language can be used to communicate over HTTP with our servers.

The query result can be returned either in XML format or NPL table format. The latter is more compact and more readable by human beings and is the default format used by our official servers.

API Methods

APIs are organized by namespaces. The sample code in this article assumes that you are using the NPL web service wrapper which is located in script/app/API folder of the client installation.

auth paraworld.auth.AuthUser paraworld.auth.Logout paraworld.auth.VerifyUser paraworld.auth.CheckVersion? paraworld.auth.SendConfirmEmail friends paraworld.friends.get paraworld.friends.add paraworld.friends.remove profile paraworld.profile.SetMCML paraworld.profile.GetMCML users paraworld.users.getInfo paraworld.users.setInfo paraworld.users.isAppAdded? paraworld.users.Find paraworld.users.Search paraworld.users.Invite file? paraworld.map.UploadFile Paraworld.file.CreateFile Paraworld.file.DeleteFile Paraworld.file.GetFile Paraworld.file.RenameFile Paraworld.file.FindFile

worlds paraworld.map.PublishWorld paraworld.map.GetWorldByID paraworld.map.UpdateWorld paraworld.map.RemoveWorld paraworld.map.JoinWorld paraworld.map.MqlQuery? paraworld.map.LeaveWorld paraworld.map.VisitWorld paraworld.map.GetWorlds map paraworld.map.OfficialMap? paraworld.map.UserMap? paraworld.map.GetMapMarkOfPage paraworld.map.GetMapMarksInRegion paraworld.map.GetMapModelByIDs paraworld.map.GetMapModelOfPage paraworld.map.GetTilesInRegion paraworld.map.GetMapMarkByID paraworld.map.AddMapMark paraworld.map.RemoveMapMark paraworld.map.AddModel paraworld.map.GetModelByID paraworld.map.UpdateModel paraworld.map.RemoveModel paraworld.map.SearchMapMark paraworld.map.AddTile paraworld.map.GetTileByID paraworld.map.UpdateTile paraworld.map.BuyTile

MQL paraworld.MQL.query actionfeed paraworld.actionfeed.PublishStoryToUser paraworld.actionfeed.PublishActionToUser paraworld.actionfeed.PublishRequestToUser paraworld.actionfeed.PublishMessageToUser paraworld.actionfeed.PublishItemToUser paraworld.actionfeed.sendEmail inventory paraworld.inventory.GetBag? paraworld.inventory.AddItem? paraworld.inventory.RemoveItem lobby paraworld.lobby.CreateRoom paraworld.lobby.JoinRoom? paraworld.lobby.GetRoomList paraworld.lobby.PostBBS paraworld.lobby.GetBBS marketplace paraworld.marketplace.GetBags? paraworld.marketplace.AddBag? paraworld.marketplace.RemoveBag?

Additional documentation

• Authentication guide?
• Error codes

Usage Examples in NPL

• Photo uploads?
• Marketplace Listing?
• Map Editing?
• Publish World?
• Profile box MCML?
• User and friends Info?

External tools

• ParaWorld's api UnitTest console
• TODO: Create our own test console as a TestConsoleApp?

]]