Introduction

The Planviewer Maps API enables developers to embed maps into third party applications. Optionally access to these maps may be restricted using OAuth 2.0.

This documentation consists of four main sections. First, the Maps API Dashboard section gives an intruction into the dashboard profile pages for the Maps API. This is where you need to start by configuring an application (onto which maps will be created and configuration changes can be made, see the glossary).

The second section is on embedding a map into your application. This will allow you to create a viewer for your map available on another website. If OAuth is enabled you may also optionally choose to embed an editor in your application, allowing users to directly edit the content of the map on your site.

The third section is on using the server-side API. These server calls allow your application to retrieve data, create new maps and modify existing maps. Finally if access restrictions are required or the editor is to be enabled in your application read about enabling OAuth in the final chapter.

Workflow

  1. In the Planviewer Maps API dashboard an Application should be created by the Reseller of the Customer.

  2. For the Application the following can be configured:

    1. An Access Key can be generated for Server-to-Server communication. See Server Calls for information on what this API enables.
    2. An OAuth Configuration can be set.
    3. Background layers can be added such as OpenStreetMaps or aerial photo’s from PDOK.
  3. Using either the dashboard or Server Calls a Map can be created.

  4. If OAuth is configured the developer may choose to disclose the Editor by embedding it in a third party application. Otherwise the Editor is accessible via the Maps API dashboard.

  5. In the Editor a user may define the Dossiergrens.

  6. After the Dossiergrens is saved, optionally shapefiles can be uploaded to define User layers.

  7. Finally the read-only Viewer can be embedded in a third party application. Unless OAuth is enabled, this Viewer is publicly available.

Glossary

Application
An application is used to allow access from your platform to the planviewer data. You can maintain a different set of security credentials, a different set of map layers and a different set of maps per application.
Map
A map can be displayed on your own webpage. A may be edited using the editor (either embedded in your own website using OAuth or directly using the map panel in the Maps API Dashboard). Alternatively you may sometimes see the term viewer.
API Access Key
An API Acccess Key allows a server to use the server API methods provided by the Maps API. The API Access Key is acting as a username for your server, whereas the Access Key Secret is used as a password and should never be known publicly.
Access Key Secret
See API Access Key.
Background layer
A background layer is a layer that cannot be edited by your users and is enabled for all maps in your application. A background layer may either be a base layer or an overlay layer.
Base layer
A base layer is a background layer that lays at the below all other layers. There may only be a single base layer active at the same time. A layer switcher allows users to switch between base layers you provided in your application.
Overlay layer
Overlay layers are background layers on top of the base layer but below the user layers. There may be multiple overlay layers active at the same time.
User layer
A user layer is created via the editor for a map. A user layer consists of a set of geometries and attached properties (features) and may include a Styled Layer Descriptor (SLD) for styling these features.
Features
A feature is a property on a layer. Specifically a feature will generally consist of a geometry and a set of extra key-value properties. A layer may contain zero or more features (unbounded).