ParkMobile - Permits API Integration

Introduction

ParkMobile is a service that offers on-demand parking payments, similar to HotSpot.

A system task is run at regular intervals to retrieve permits from the ParkMobile API, which are then stored in the local site as temporary permits.

Authorization Credentials

ParkMobile has a set of credentials that must be entered before data can be retrieved from their API.

These can be entered on the system settings page, which can be found under the menu tree:

• System Configuration → System Setting

  ParkMobile System Settings

  Before the system task can be run and allowed access to the ParkMobile API, the proper API credentials must be entered in the relevant system settings, found under third-party settings.

Required Credentials

There are three values that must be provided for the system to be allowed access to the ParkMobile endpoint.

These values should be provided to the client by ParkMobile itself.

• API Username

• API Password

• X-API-Key

Lot Zone Setup

Permits will only be imported into the OPS-COM system if the ParkMobile lot zone has a corresponding lot zone with the same name in the OPS-COM system.

If the local lot zone does not already exist for the ParkMobile lot zone, one will need to be created.

The lot zone management page can be found under the menu tree:

• System Configuration → Parking → Manage Lot Zones

Lot Zone Management

To create a new lot zone, click on the Add Lot Zone button to open the add new modal.

This will open the modal used to add new lot zones.

Add the ParkMobile lot zone name as the Name of the lot zone, and then click save changes.

This will add the new lot zone to the system, which can now be used to match to ParkMobile permits coming into the system.

System Task

The ParkMobile system task is used to fetch permits from the ParkMobile endpoint and add them to the OPS-COM system as temporary permits.

System tasks can be be found under the menu tree:

• Tools → View System Task Logs

System Tasks Page

The system task is named Fetch ParkMobile Stats.

The task must be enabled before it will run.

By default, it is set to run every 3 minutes.

The task can also be run manually by pressing the RUN button next to the task name.

Imported Permits

ParkMobile permits are imported as paystation (Cale) records, and will appear anywhere these records are used.

They can be viewed using the Pay Station Status page, which can be found under the menu tree:

Pay Station Status