Layar Developer Documentation

Back to layar.com

API Revision History

Date Changes
20/03/2012
  • Introduced API v6.2.
  • Added support for AR videos, added hotspots.object.previewImage parameter.
  • On the root level of the getPOIs response, disableClueMenu parameter is deprecated. radius, refreshDistance, actions and biwStyle parameters are only used in Geo layers. They are deprecated for Vision layers.
  • Inside the hotspots json dictionary, text object, imageURL, showSmallBiw, showBiwOnClick, biwStyle, icon object, object.reducedURL and inFocus are only used for Geo layers. They are deprecated for Vision layers.
  • Inside the actions json dictionary, closeBiw is only used for Geo layers.
  • hotspots.object is mandatory for Vision layers.
  • In getPOIs request, modified the algorithm of creating userId in API v6.2.
05/01/2012
  • contentType in actions should be mandatory
02/11/2011
  • Added oauth_body_hash parameter to the getPOIs request.
26/08/2011
  • Added recognizedReferenceImage parameter to the getPOIs request for Layar v6.0 and above.
15/08/2011
  • New API v6.0 (Layar Vision) is released to developers. A beta client on Android is available.
11/04/2011
  • New API v5.0 (animation and sharing APIs) is officially available.
23/09/2010
  • New API v4.0 is officially available in Layar v4.0 on Android.
14/05/2010
  • Added HTTP User-Agent header to identify the Layar app version, device model and device OS version
  • Added 'requestedPoiId' parameter to the request (used to indicate which POI the user clicked in Layar Stream, try to include it in the response)
  • Added 'version' parameter to the request (API version number used by the client)
  • Added 'inFocus' parameter to the response (can be used to indicate which POI should be in focus when opening the layer).
07/05/2010
  • Added 'doNotIndex' parameter to the response for Layar Stream opt-out on POI level 
13/02/2010
  • Added 'lang' parameter to the documentation
18/12/2009
  • Clarified which GetPOI params are optional and which are mandatory.
  • Added note that params can be added in newer versions of the client, therefore unknown params should be ignored by the layer developer rather than causing an error.
  • Added note about audio:// and video:// actions not being supported in web pages.
  • Clarified fallback mechanism for "full", "reduced" and "icon" in 3D objects.
01/12/2009
  • We briefly changed the CHECKBOXLIST stuff, decided to leave as Comma-separated list.
30/11/2009
  • Added v3 changes, all marked in blue
29/10/2009
  • Added new actions: audio, video and custom apps
3/10/2009
  • Minor clarification of string formats for the JSON response
21/8/2009
  • Added 'mailto:' URI as possible action
  • Removed the limit on the number of actions, this is not enforced
  • Changed BIW strings requirements. Please check you're not sending HTML, just unicode strings. We're going to check this in the next version of the APK. Unfortunately the current version is a bit easy on this and we may have given you the wrong impression that HTML entities are supported. This would break on other platforms (like the iPhone), so we're going to change it. We'll give you a new developer APK in time to check your layer.
20/8/2009
  • Minor changes to the Pagination section.
15/8/2009
  • There was a mistake in the example request (and in the API): The request contained a UserId and the same parameter got duplicated as a PhoneId, which wasn't documented in our API. This has been removed.
14/8/2009
  • Added limitation on actions: Max 4 actions will be used on the client
  • Added limitation on POIs: Max 50 POIs will be displayed on the client
  • Added examples for "actions" and custom errors
  • Added links to MySQL and MS SQL database queries
  • Added explanation about selection of POIs by the client within the range
  • Changed the way %distance% is shown on the client
2/8/2009
  • Added request/response example without OAuth signing
  • Added requirement to pass back every key in the JSON response, filling it with 'null' if unused.
31/7/2009
  • Clarified way BIW image is scaled.
29/7/2009
  • Changed the way errors are displayed: Layer Service Provider can send his own error/status messages that will be displayed in the client.
  • Added size of BIW image.
  • Changed the lengths limitations for the text in the BIW
23/7/2009
  • Removed reference to point-to-point layers. Will be announced later. The client doesn't support it (yet).
22/7/2009
  • RADIOLIST parameter contained an error: The client uses the optionid defined in the layer parameters, not the actual value seen by the user.
  • Pagination: Explanation didn't make sense for this API.
21/7/2009
  • %distance% instead of @distance
20/7/2009
  • Added error codes in response for GetPointsOfInterest
  • Added a paragraph detailing possible string formats for the BIW strings
  • added @distance variable in strings for BIW (which client will replace with actual distance in meters)