Access to the Parking API is offered as a paid service. Please contact your Autopay representative for details.
Service: makes a HTTP POST request to your webhook endpoint when vehicles enters a zone in your facility
Webhook endpoint requirements:
- Provide a webhook endpoint with HTTPS support
- Support HTTP header authorization (we will send you the secret you provide us in the "Authorization" header)
What we need to configure your webhook:
|The URL to your webhook endpoint
|Authorization token value
|What we will send you in the "Authorization" HTTP header
|The code for the facility you want to receive events from
|The code for the zone(s) you want to receive events from
|Should all zones be included?
|If all zones in facility, including new ones, should be included
|The id for the landlord that the facility belongs to
Webhook POST JSON:
|A unique id for the entry event. Updates on the same event uses the same id. So if a license plate is updated, it will be present with the corrected license plate with the same 'event_id'.
|Id can be used to change the product for this parking session.
|Time of entry event in UTC.
|Id of the parking operator.
|Id of the landlord of the parking facility where the parking takes place
|Display name of the landlord
|Id of the parking zone where the parking takes place
|Display name of zone
|Id of the parking facility where the parking takes place
|Display name of the facility
|Time zone of the facility, in the format "Europe/Oslo"(https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
|The vehicle registration number
|The plate country code in Alpha 2 code (iban.com/country-codes)
|Subdivision on the vehicle registration if it exists
- A valid authentication token is required to access the API. How to authenticate your application.
- You will need to provide the product IDs you will use for different product changes that can be done to your Autopay representative.
Service: change the product of a parking session
This method allows you to change the product of a parking session, so that you can e.g. allow some customers to park longer for free.
- The request body must be in JSON format and HTTP headers must include
- The HTTP headers must include a valid access token.
- The path must include the parking session ID received in webhook.
|Id of the parking facility where the parking takes place.
|Id of the parking zone where the parking takes place.
|The product ID of the new product the parking should receive.
HTTP Code: 200 OK
|Specific code of error. See below for possible values
|Description of error
|Optional value. Additional description of error.
Example error response:
Possible error id-s:
|Internal server error
|A problem with the request body
|Used REST method not supported
|The operator id in the authorization is invalid
|Internal Server Error
|Requested product change was not found for the zone
|Facility or zone in request is invalid
|The parking session is invalid/does not exist
|The parking session has invalid status (e.g. it's set to error)