PrixCar Transport Web Services API

Introduction

One of the hidden gems in our toolbox is the PrixCar Transport Web Services API. The PrixCar Transport Web Services API enables third-party applications to communicate with our Quoting System and request car transport quotes to most places in Australia – all behind the scenes.

APIs are implemented from the documentation or the “schema” of the API so developers can code their system to work with our system.

Simply put, APIs are like translators that interact with the outside world, yet maintain the integrity of all the data and security within the application. Application Programming Interfaces are known as “APIs” for short. People tend to use APIs to allow an application to talk to another application.

The PrixCar Transport API uses standard RESTful services as it’s communication method. All data is exchanged in JSON format.

Requests

When making requests to the PrixCar Transport Web Services API, you’ll be sending defined values to API services that reside at a URL provided by PrixCar Transport Services.

An “API service” is an exposed endpoint in our system that you can access to perform an operation or to request data. Each service performs a single atomic operation. To make a call, you will need to know five things:

All urls to access the API are http://appname. Replace appname with the correct domain as provided by PrixCar Technical Services.

  • The API service URL, E.g. http://appname/WEBAPI
  • The name of the service and the method, as defined by the Service Documentation
  • The encrypted API key, which will be provided by PrixCar Transport Services
  • All required parameters to pass to the service, as defined later in this documentation
  • How the API service will respond to you, as defined later in this documentation

To summarise, you will invoke some command on our servers and pass all the information necessary to complete that command. We will then formulate a response and send it back to you.

Authentication

All requests to the PrixCar Transport API must be made over a HTTP connection and authentication is handled by passing your private API Key and username as parameters in your request, as outlined below.

http://appname/WEBAPI/retrieve_quote?APIKey=ff6f3bdb-e1d8-4dfb-bd78-9aa838bed314&UserName=prixcar

Response

All data is returned in JSON format and contain the API Key and user name, and any required parameters to make a valid request.

JSON Response Formats

The JSON object is built in two structures:

  • A collection of name/value pairs. In various languages, this is realised as an object, record, struct, dictionary, hash table, keyed list, or associative array.
  • An ordered list of values. In most languages, this is realised as an array, vector, list, or sequence.

In its simplest form, a JSON object is just a comma delimited set of name/value pair, for example:

{"name one":"value one","name two":"value two"}

Responses specific to the available services are defined on their corresponding pages.

Available Services

The PrixCar Transport Web Services API provides support for two key functions.

Services related to obtaining a car transport quote are defined in the Quotes API.

Services related to booking a vehicle for transport are defined in the Bookings API.