Layar Developer Documentation

Back to layar.com

API Documentation

RESTful calls

All calls are RESTful so they adhere to the REST architecture. Currently one HTTP GET call has been defined for fetching resources:

The requests conform to HTTP/1.1.

Normalized request parameters

All requests will be made using normalized request parameters conforming to the following rules:

  1. Gather the GET query parameters.
  2. Parameters are sorted by name, using lexicographical byte value ordering. If two or more parameters share the same name, they are sorted by their value.
  3. Concatenate the parameters in order and delimit as follows:
    1. By name and value with an '=' character delimiter (ASCII code 61)
    2. For parameters containing more than one value, concatenate the values with a '+' character delimiter
    3. By pairs with an '&' character delimiter (ASCII code 38)
  4. If the parameters contain UTF-8 encoded strings, these must be replaced by their corresponding %HH bytes values, see here.
  5. URL escape the parameter string.

Signing of requests according to OAuth

Developers can choose to receive signed requests. The signing will conform to OAuth signing requests and the signing parameters can be set for each layer using the Layar Publishing Website. Only HMAC-SHA1 signature method is supported. The Signature Base String is generated using:

  1. The HTTP method: GET
  2. The URL for the request: e.g. http://layarapi.example.net/mylayer/getpoi
  3. The normalized request parameters, including the oauth request parameters, excluding oauth_signature. The oauth request parameters used by the Layar Developer API are: oauth_consumer_key, oauth_signature_method, oauth_timestamp, oauth_nonce, oauth_body_hash and oauth_version.

GetPOIs Response format

The API currently accepts only JSON response format. Make sure your HTTP response headers declare the correct content type: application/json or text/javascript. Also make sure you encode your response in UTF-8 and add charset=utf-8 to your content type header:

Content-type text/javascript; charset=utf-8

JSON (JavaScript Object Notation) is a machine-readable data exchange format using conventions derived from the C family of programming languages. JSON is built on two universal data structures:    

  1. A collection of name/value pairs represented as a user-defined object.
  2. An ordered list of values represented by an array.

JSON data separators are identical to those used by JavaScript engines to represent data structures such as strings and arrays. This provides for easier data access than what would be achieved with XML. JSON is less verbose than XML and lacks certain properties that are available in the latter. For example, namespaces allowing identical pieces of information to be mixed in different contexts in XML are not available in JSON. Converting from XML to JSON can present challenges when distinguishing between the actual value of attributes and text between tags, because JSON assignments are created with colons.

Some general conventions

Date formats

All timestamps are integers, in number of milliseconds since 1/1/1970 UTC. They are currently only used in order to compare values, the absolute value does not matter.

Color formats

All colors are integers (base-10), based on RGB: 0xrrggbb where rr is 2-byte hexadecimal code for red (0xFF is maximum), gg is 2-byte code for green and bb is 2-byte code for blue. So a pure yellow color would be 0xFFFF00 which translates to an integer of 16776960.

String formats

All strings are UTF-8 encoded.

Examples are:



  1. http://custom.layar.nl/layar image.jpeg should be http://custom.layar.nl/layar%20image.jpeg ->space should be encoded as %20
  2. http://custom.layar.nl/focus图 像.png should be http://custom.layar.nl/focus%E5%9B%BE%E5%83%8F.png -->special characters in other languages should be encoded.

IP address range of Layar Server

Currently (updated on 20th March 2012), the IP address range of the layar server is:

NOTE: This IP range will be updated from now and then. If you experience any issue, please contact us at http://devsupport.layar.com.