Introduction
============

The Planviewer API is actually a set of different API's operating within the same authorization context.
Third party *Applications* can integrate with the Planviewer service.
For each of these applications different authentication methods can be configured.
This section is dedicated to the creation and configuration of these *Applications*.

Workflow
--------

1. In the :doc:`Planviewer API dashboard <dashboard>` an *Application* should be created by
   the *Reseller* of the *Customer*.
2. For the *Application* the following can be configured:

    a. An :doc:`Access Key <accesskeys>` can be generated for Server-to-Server communication.
    b. An :doc:`OAuth Configuration <oauth>` can be set.

3. Either the :doc:`Maps API </mapsapi/introduction>` or the :doc:`Product API </productapi/introduction>` can be enabled.

.. _api-glossary:

Glossary
--------

.. 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.

    Reseller
        The party that interacts with Planviewer on a business-level.
        The user account of the reseller is used to configure all aspects of the Product API.

    Customer
        The party that interacts with the reseller, and uses an *Implementation* to interact with Planviewer services.

    Implementation
        A system that implements the Planviewer Product API, and thus consumes products.

    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*.