Please NOTE that this documentation will not be updated anymore. Please see our new Developer Documentation Site for the latest updates! The content of this page can be found here.
|
In this section we will explain the general steps to creating and publishing a layer.
1. Layer components
Layers consist of three parts:
- Layer definition: Created using a web form on the Layar Publishing site
- Points of Interest (POI) within a layer: Fetched directly from the Layer Service Provider via the API.
- Detailed pages for each POI (optional): Hosted by the Layer Content Provider (layer developer), accessed directly from the client.
The layer definition is provisioned on the
Layar Publishing site via a web interface. Here all the fixed parameters associated with a layer can be defined. These parameters are stored in the Layar Database and can be accessed by the Layar app.
Once a layer has been defined, it can be listed in the Layer Gallery in the client. When the user selects this layer in the client, the POIs for the layer will be fetched for the current location, using filter parameters that can be set on the device.
The POIs are fetched directly from the Layer Service Provider by the Layar Server using the Layer Developer API. The calls are real-time, that is each time the client needs to fetch a new list of POIs, a call will be made by the Layer Server using the API. The developer should therefore expose a REST webservice to the Layar Server according to this API specification.
For each POI, there may be more detailed content to show, or interaction possible with the end-user. This can be achieved by hosting web pages (made for mobile) that will be shown within the Layar client app as web views when a user selects the POI. These pages are accessed directly by the Layar client over the Internet.
2. Step-by-step instructions
Basically, the whole layer creation and publication process can be described using the following 7 steps (see flowchart below):
steps to create and publish a layer
Step 1 : Sign up to be a developer
- Before being able to use the developer publishing site, please register a layar account at layar website (www.layar.com). For detailed instructions on how to sign up to be a developer, please read Sign up to be a developer.
- Once logged in with layar account (with developer role enabled), you should see a "My layers" button next to the layar account user name. Click on "My layers" button, you should be redirected to the publishing site environment.
NOTE: If the "My layers" button is not shown after logging in, please let us know by sending a developer support ticket.
Step 2: Create a layer
- To create a layer, please just click on "Create a layer" (an orange button) under the "layers" tab of the developer publishing site.
- For more information on how to fill in the create a layer page, please visit Create a layer.
Step 3: Edit a layer
- To customize a layer, please just click on "Edit" button under the "layers" tab of the developer publishing site.
- For more information on what fields are customizable, please visit Edit a layer.
Step 4: Set up database and web service
- In order to get a layer working, the key is to set up the communication between a layer and layar platform. Developers need to build a web service to provide the right response to layar platform.
- For more information, please visit the following content:
Step 5: Test a layer
- To check whether a layer is functioning well, testing is always important. On the developer publishing site, a API test page is provided to test the request/response from your web service and see the Layar server's logs to track down any issues. Click on the "Test" button under the "layers" tab to open the API test page.
- Before submitting layer publication request, it is very important to test your layer thoroughly against the Layer testing instructions .
- If you want to publish a premium layer, please also check the Additional paid layer approval requirements.
Step 6: Request for publication
- Once the layer is ready, developers can request for publication approval by clicking on "request for approval" button under the "layers" tab.
- layer will be reviewed by layar staff. A layer publication request will be either approved or rejected with reviewing comments.
NOTE that the layer review process can take up to 5 working days.
Step 7: Publish a layer
- Once a layer publication request is approved, the layer can be published by the publisher (the layer owner). Click on the "publish" button under the "layers" tab and the layer will be live in Layar application on the phone.
Comments (0)
You don't have permission to comment on this page.