API - Setup Access

You can setup a new API key to integrate with external applications such as ZapierEvent Hawk, or custom integration. API access does require our WordPress/API module which can be activated here.

Create an API token

1. Go to the "API Keys" under Settings (must be using admin account)
2. Click Add New
3. Click generate for an API token, and copy to clipboard
4. It is recommended that you put the IP addresses of the servers making API calls in the restriction

Grant Access Permissions

1. Go to the permissions section when editing an API token
2. Grant access to the appropriate areas this API profile will be using.
    Common ones include Settings Rental Inventory, Settings Categories, Customers, and Leads.
    For creating leads, you'll need Full Access for "Create Leads"

Test it by Getting a List of your Rentals

1. Go to https://rental.software/api6/rentals?apiKey=

2. Paste your API token at the end of the URL
3. Results:
Success - You get a list of rental details (json encoded)
Failure - API key not provided
Failure - API key not found (you typed your key wrong)
Failure - You don't have permission (see the permissions tab of the API worker profile)

Need More Details Returned?

You can often add _body=true to a GET call to retrieve more info, but the request may take a little longer.

Rate Limit

We have a rate limit per API key of 300 calls in 300 seconds. If you hit the limit, your requests will be rejected until enough time passes that you are under limit again. The rejection is html code 429 Too Many Requests. Our support team is notified when this occurs via an automated email. Only one email is sent per hour, regardless of the number of rejected calls.

Full API docs can be found here.

Is this article helpful?
0 0 0