APT.MobileAPI Getting Started

Introduction

The APT.MobileAPI Service has been developed to enable the creation of mobile applications which offer mobile payment, or other loyalty services such as discounts.

Authorisation Keys

All API calls (excluding GetAPIKey) require a valid API Key. API calls made with a missing or invalid API Key will return an HTTP Error 403 (forbidden).

Generating your API Key should be a one-time operation. You only need to generate a new API Key if the previous one is lost or compromised.

Customer Key

A unique Customer Key will be provided by APT SKIDATA. The Customer Key gives you the ability to request and revoke your API Key.

The Customer Key is to be kept safe, and MUST NOT be distributed in any form.

API Key

All API calls must include a valid API Key. Use the GetAPIKey function to request your API Key.

It is your responsibilty to keep this key secure, and it is recomended that you encrypt the key if it is to be distributed within an application.

If you feel the security of your API Key has been compromised then you should request a new key using the GetAPIKey function.

ApplyPayment

Apply confirmation of payment to a parking transaction.

API	Description
GET api/ApplyPayment?APIKey={APIKey}&FacilityNo={FacilityNo}&TicketNo={TicketNo}&TicketType={TicketType}&Amount={Amount}&AuthorisationCode={AuthorisationCode}&PaymentTime={PaymentTime}&CustomerID={CustomerID}	GET implementation of ApplyPayment
POST api/ApplyPayment	POST implementation of ApplyPayment

ApplyPromotion

Apply confirmation of promotional payment to a parking transaction.

API	Description
GET api/ApplyPromotion?APIKey={APIKey}&FacilityNo={FacilityNo}&TicketNo={TicketNo}&TicketType={TicketType}&Amount={Amount}&AuthorisationCode={AuthorisationCode}&PaymentTime={PaymentTime}&PromotionValue={PromotionValue}&PromotionCode={PromotionCode}&PromotionDescription={PromotionDescription}&CustomerID={CustomerID}	GET implementation of ApplyPromotion
POST api/ApplyPromotion	POST implementation of ApplyPromotion

ApplyValidation

Apply the chosen validation to a parking transaction.

API	Description
GET api/ApplyValidation?APIKey={APIKey}&FacilityNo={FacilityNo}&TicketNo={TicketNo}&TicketType={TicketType}&ValidationProviderNo={ValidationProviderNo}&ValidationSource={ValidationSource}&CustomerID={CustomerID}	GET implementation of ApplyValidation
POST api/ApplyValidation	POST implementation of ApplyValidation

CalculatePayAndDisplayRate

Calculate the rate a parking transaction.

API	Description
GET api/CalculatePayAndDisplayRate?APIKey={APIKey}&FacilityNo={FacilityNo}&TicketNo={TicketNo}&TicketType={TicketType}&TargetRateEndTime={TargetRateEndTime}	GET implementation of CalculatePayAndDisplayRate
POST api/CalculatePayAndDisplayRate	POST implementation of CalculatePayAndDisplayRate

CalculateRate

Calculate the rate a parking transaction.

API	Description
GET api/CalculateRate?APIKey={APIKey}&FacilityNo={FacilityNo}&TicketNo={TicketNo}&TicketType={TicketType}	GET implementation of CalculateRate
POST api/CalculateRate	POST implementation of CalculateRate

CreateMultipleUseIdentifier

Create a multiple use Identifier for a parking facility to allow entry/exit.

API	Description
GET api/CreateMultipleUseIdentifier	GET implementation of CreateMultipleUseIdentifier
POST api/CreateMultipleUseIdentifier	POST implementation of CreateMultipleUseIdentifier

CreatePayAndDisplaySession

Calculate the rate a parking transaction.

API	Description
GET api/CreatePayAndDisplaySession?APIKey={APIKey}&FacilityNo={FacilityNo}&TicketNo={TicketNo}&TicketType={TicketType}&TargetRateEndTime={TargetRateEndTime}	GET implementation of CalculatePayAndDisplayRate
POST api/CreatePayAndDisplaySession	POST implementation of CalculatePayAndDisplayRate

CreateSingleUseIdentifier

Create a single use Identifier for a parking facility to allow a single entry/exit during the specifed time window.

API	Description
GET api/CreateSingleUseIdentifier	GET implementation of GetFacilityConfiguration
POST api/CreateSingleUseIdentifier	POST implementation of GetFacilityConfiguration

DeleteIdentifier

Delete an Identifier from a parking facility.

API	Description
GET api/DeleteIdentifier?APIKey={APIKey}&FacilityNo={FacilityNo}&ReferenceNo={ReferenceNo}	GET implementation of DeleteIdentifier
POST api/DeleteIdentifier	POST implementation of DeleteIdentifier

ExtendPayAndDisplaySession

Calculate the rate a parking transaction.

API	Description
GET api/ExtendPayAndDisplaySession?APIKey={APIKey}&FacilityNo={FacilityNo}&TicketNo={TicketNo}&TicketType={TicketType}&TargetRateEndTime={TargetRateEndTime}	GET implementation of CalculatePayAndDisplayRate
POST api/ExtendPayAndDisplaySession	POST implementation of CalculatePayAndDisplayRate

FinalizeTransaction

Finalize the transaction details of a post-payment event.

API	Description
GET api/FinalizeTransaction?APIKey={APIKey}&FacilityNo={FacilityNo}&TicketNo={TicketNo}&TicketType={TicketType}&Amount={Amount}&AuthorisationCode={AuthorisationCode}&PaymentTime={PaymentTime}&PromotionValue={PromotionValue}&PromotionCode={PromotionCode}&PromotionDescription={PromotionDescription}&EventID={EventID}&CustomerID={CustomerID}	GET implementation of FinalizeTransaction
POST api/FinalizeTransaction	POST implementation of FinalizeTransaction

GetAPIKey

Request an API Key to use with the APT.MobileAPI Service.

API	Description
GET api/GetAPIKey?CustomerKey={CustomerKey}&RevokeExistingKey={RevokeExistingKey}	GET implementation of GetAPIKey
POST api/GetAPIKey	POST implementation of GetAPIKey

GetArticles

Get a list of all available Validation Providers for the chosen Parking Facility.

API	Description
GET api/GetArticles?APIKey={APIKey}&FacilityNo={FacilityNo}	GET implementation of GetValidationProviders
POST api/GetArticles	POST implementation of GetValidationProviders

GetAvailableFacilities

Request a list of Facilities you are authorised to use with the APT.MobileAPI Service.

API	Description
GET api/GetAvailableFacilities?APIKey={APIKey}	GET implementation of GetAvailableFacilties
POST api/GetAvailableFacilities	POST implementation of GetAvailableFacilties

GetFacilityConfiguration

Get location and VAT information for the requested facility.

API	Description
GET api/GetFacilityConfiguration?APIKey={APIKey}&FacilityNo={FacilityNo}	GET implementation of GetFacilityConfiguration
POST api/GetFacilityConfiguration	POST implementation of GetFacilityConfiguration

GetOccupancy

Request the counting catergory or storey occupancy data for a carpark

API	Description
GET api/GetOccupancy?APIKey={APIKey}&FacilityNo={FacilityNo}&Carpark={Carpark}&Type={Type}&Index={Index}	GET implementation of GetOccupancy
POST api/GetOccupancy	POST implementation of GetOccupancy

GetRateConfiguration

Get location and VAT information for the requested facility.

API	Description
GET api/GetRateConfiguration?APIKey={APIKey}&FacilityNo={FacilityNo}&CarparkNo={CarparkNo}&RateNo={RateNo}	GET implementation of GetRateConfiguration
POST api/GetRateConfiguration	POST implementation of GetFacilityConfiguration

GetTicketFromBarcode

Retrieve the Ticket and Facility information using the ITF or QR barcode printed on the Ticket.

API	Description
GET api/GetTicketFromBarcode?APIKey={APIKey}&Barcode={Barcode}	GET implementation of GetTicketFromBarcode
POST api/GetTicketFromBarcode	POST implementation of GetTicketFromBarcode

GetTicketFromPartial

Search for the full Ticket number using only the last 6 digits printed on the Ticket.

API	Description
GET api/GetTicketFromPartial?APIKey={APIKey}&FacilityNo={FacilityNo}&PartialTicketNo={PartialTicketNo}	GET implementation of GetTicketFromPartial
POST api/GetTicketFromPartial	POST implementation of GetTicketFromPartial

GetTicketFromPlate

Search for the full Ticket number using the vehicle registration number.

API	Description
GET api/GetTicketFromPlate?APIKey={APIKey}&FacilityNo={FacilityNo}&Plate={Plate}	GET implementation of GetTicketFromPlate
POST api/GetTicketFromPlate	POST implementation of GetTicketFromPlate

GetValidationProviders

Get a list of all available Validation Providers for the chosen Parking Facility.

API	Description
GET api/GetValidationProviders?APIKey={APIKey}&FacilityNo={FacilityNo}	GET implementation of GetValidationProviders
POST api/GetValidationProviders	POST implementation of GetValidationProviders

TransactionMonitor

Websocket endpoint which provides realtime transaction notifications for single and multi use identifiers

API	Description
GET api/TransactionMonitor?APIKey={APIKey}	GET implementation of TransactionMonitor