How do I upgrade from V3.1 to V3.2 of the Agent/Web API

How do I upgrade from V3.1 to V3.2 of the Agent/Web API

If you are currently using V3.1 of the API, then it is quite a simple job to upgrade using V3.2.

The first thing you would need to do is contact RCM Support (support@rentalcarmanager.com) so that they can determine if you will require a new API key to access the new version.

They can also make sure that you have a login to the Sandbox area, this login will give you access to all the information you will require regarding API keys, Developer’s Guides, sample code and a test area.

Reasons to Upgrade to V3.2


V3.2 of the API offers the following benefits over V3.1

True Json datasets both in and out of the API.
The rental rates are returned as seasonal rates rather than an averaged rate where the flag has been set in the RCM system.
New methods have been developed which are detailed in a section below.
V3.2 is the first step towards allowing you to build your own Booking Maintenance module which you can host on your own website. This will allow you to enable customers to update their bookings.

API Keys for V3.2

With the new version of the API (V3.2), the use of encryption to sign each request is now mandatory for all keys. How to use these signatures is detailed in the Developer’s Guide for V3.2. This can be found within the Sandbox area.

As a result of this new signature, you may not be able to use the same key for both V3.1 and V3.2. RCM Support will be able to let you know.


Using only V3.1

If you are going to continue using only V3.1 of the API, then you will not need any changes made in regard to your API keys.

Using only V3.2

Any company using solely V3.2 will have to have a signature set up with their key.

Using both 3.1 and 3.2

There are two possibilities if the company is going to be using methods from both V3.1 and V3.2

If the existing API key being used for V3.1 has a signature associated with it, then they can use this key for V3.2 calls as well.
If the existing API key being used for 3.1 does not have a signature associated with it, then a new key would have to be created for V3.2 with a signature associated with it.
Depending on what version method was being called, the relevant key would need to be used.

V3.1 Methods moving to V3.2


Below is a listing of the methods that are available in V3.1 and a brief description.

There is also the matching V3.2 method, this is because some of the methods have had a name change.

.1 Method Name

Description of V2 Method

Matching V3.2 Method

Step1

Returns the available pickup and drop off locations and their office hours. Also the category types of vehicles available and the driver age information.

Step1

Step2

Returns a listing of the vehicle categories and their availability status. The rental rates and any mandatory fee information is also returned.

Step2

Step3

For the selected vehicle category, pickup and drop off locations and dates returns  the rental rates and any mandatory fee information along with any optional extra fees, insurance options, and any Kms options.

Step3

Booking

The booking method is called to save the customer’s booking request as either an unallocated booking or a quote within Rental Car Manager.

savebooking

confirmPayment

If you are processing a payment at the time of booking, then you can save the payment information against the booking using this method.

savepayment

bookinginfo

Once a booking has been made, you can use thebookinginfo method to get all of the finalised information about the booking in one call.

Bookinginfo

editbooking

Once the booking has been made call this method to update details such as optional extras, insurance and user information.

Editbooking

Extradriver

This method can be called alongside “editbooking” in order to add, update or delete Additional Drivers.

extradriver

Cancelreasons

Returns a list of the possible reasons to cancel a booking.

Cancelreasons

Cancelbooking

Calling this method allows you to cancel a booking.

cancelbooking

Agentbookings

Agents can get a list of bookings that have been made for their agent code by calling the agentbookings method.

agentbookings

locationdetails

The locationdetails method can be used to get information about a particular location.

locationdetails

geturl

Method to get url (in base64 string encoding) used to access the vault to allow user to submit their credit card details, using 3rd party vault supplier.

getvaulturl

Payment

Method to save data returned from Auric Vault.

Vaultentry

Sendemail

Method to send an email based on a fixed layout defined within the RCM system

sendemail

New Methods for V3.2

The following methods have been added as part of V3.2. More information about these can be found in both the Sandbox area and the Developer’s Guide for V3.2.

 Method Name

Description


CalctotalMethod to calculate total values + taxes based on selections made within step3 
Locationsmethod to list all locations their IDs, location relavant booking details like office hours, after hours drop off etc... and indication if it is the default location. 
Countries

Method to List all countries, the ids used by the system for those countries and if it is the default country. 

categorytypesMethod to list all category types and their IDs + rate type info. 
driveragesMethod to list all valid driver ages within in system and their IDs + indication for default age. 

    Important Articles


      • Related Articles

      • Agent API Excluded Fees

        Purpose The Web/Agent Extra Fees tab allows you to make Extra Fees available to all Agents through the Agent API. For more information on this please see the Web / Agent Extra Fees article. However, you may not want certain Extra Fees available to ...

      • Web / Agent Extra Fees

        Purpose Web/Agent  Extra Fees allows you to setup the system to apply any existing Extra fee to a Web or Agent API/Direct booking.  When flagged, they will appear on your website for selection and will be added to the booking total when selected.  ...

      • Web or Agent Insurance

        Purpose Insurance fees reduce the liability of the customer or driver in the event of an accident. Insurance fees are sometimes referred to as collision damage waivers (CDW) or excess reduction fees and are normally charged on a daily basis to reduce ...

      • Agent API

        What you can do with the RCM Agent API Our Agent API has all of the functionality that you need to be able to integrate your website with Rental Car Manager. With the RCM Agent API, developers can: Get locations and vehicle categories Get available ...

      • Updating your AGENT API to use the new API Endpoint

        Rental Car Manager has embarked on a major infrastructure upgrade, and part of this involved moving our systems off our legacy servers.   All Booking Agencies will be required to make some minor changes to use a new API URL in order for them to ...