Getting Started with Export API

Getting Started with Export API

Overview

Rental Car Manager offers an Export API to export certain datasets.  There is a cost to set up these APIs, please contact RCM support (support@rentalcarmanager.com) for more information.

Instructions for Use

 All data can be retrieved by calling a single URL, the parameters passed on the querystring will determine the type of data and filtering required.

URL & Querystring


General format for the querystring is: {URL as above}?key={keyvalue}&method={methodname}&{param1name}={param1value}&{param2name}={param2value}...etc

Key

Your key (an encrypted string of about 20 characters) will be provided when API access is granted.  You will be able to find your Key information in the Sandbox. If you do not have a key, contact RCM Support (support@rentlacarmanager.com). 

All calls to the URL requires the key.  This will identify the caller and match the request to your database.  

Shared Secret

There are further steps necessary to secure the request, this is in the form of a Shared Secret.

You will need to sign each request using the HMACSHA256 protocol. 

To create the signature: 

1. Get the part of the request URL following the domain information (including the entire query string). 

2. Use the hash secret to sign the part of the URL using HMACSHA256. 

3. Add the hex encoded result to the header of the request as the signature. 

Sample VB Code for requesting agencies:



Method

The method name for the data that requires export.  Valid method names are "repbookingexport", “bookingextrafees”, "vehicle", "customer", "location", "extraitem", "rentalsource", "salesrep", “agency” and “respayment”. A listing of all of the methods with a description can be found in the following article Export API Methods.

Over time, we may add more methods for exports.  If you see a method here that is unavailable in your system, please contact RCM Support (support@rentalcarmanager.com) to request access.

Data Returned

All data will be returned in as a JSON file.  The data will be in the form

[{first record},{next record}, {record 3}, {…}, {last record}]

where record = “fieldname1”:”fieldvalue1”,”fieldname2”:”fieldvalue2”, … ,”fieldnameX”:”fieldvalueX”

No records found will return “[]”

Request Rate Limits

From November 2019 each export method has constraints around how many requests may be made per day.  In some cases there is also a defined maximum date range.  See each method definition in the article Export API Methods for further information.  If you require a higher level of access to this API please contact us for pricing details.

    Important Articles


      • Related Articles

      • Getting Started with Post Booking API

        Introduction Version 3.2 of the Post-Booking API allows web developers to access the core post-booking methods for Rental Car Manager systems. Note that the methods in this document all refer to post-booking methods, i.e. involving the update of ...
      • Export API Methods

        Overview Rental Car Manager offers an Export API to export certain datasets. Each of the methods available is discussed below. For detailed information about getting started with connecting to the Export API, see the article Getting Started with ...
      • Getting Started with API V3.2

        Overview Rental Car Manager (RCM) provides a Web API through which you are able to use to build a set of booking steps which you can plug into your website. This API also allows for Agents to have access and search for availability of vehicles and to ...
      • Infringement API

        Introduction The Infringement API can be used to look up vehicle and driver details for infringements such as traffic fines. You can also use it to record infringement details against a reservation, add a fee, and take a payment where applicable. ...
      • Updating Bookings using Post Booking API

        Overview The Post Booking contains methods which allow you to perform different actions on a booking in RCM. Two of the methods allow you to update the booking information. The difference between the two methods is the information that you are able ...