The API (Application Programming Interface) frees you to use Honest Renter's system without having to be on our website. You can fetch, add, or modify information in our database from any web-enabled computer or server. This means that you can include Honest Renter's tests on your own websites, or display results in your own customized reports.
Anyone. There's nothing to download. All you need is an Honest Renter account, and to let us know which domains to authorize.
Property management companies: Branding is important. There are good reasons for wanting prospective tenants to complete all application materials on your own website. Honest Renter's API gives you full control over the look, feel, and location of materials.
Tenant screening companies & property management software companies: Want to add personality tests to your list of services? As a certified reseller/distributor of Honest Renter products, you have complete control of the tenant and landlord experience. White labeling is also available, allowing you to re-brand Honest Renter's products to truly make them your own.
REST: Our API is organized around REST. We use predictable, resource-oriented URLs. HTTP response codes indicate API errors. Cross-origin resource sharing (CORS) allows secure interaction with our API from any browser or server. All requests return standard JSON for easy parsing, even for error messages. Objects are also expandable, allowing you to retrieve chained objects in a single API call.
Live example: Us! We're our own client. Every interaction between our website and database is done through the API. If we can do it, so can you! To recreate the functionality of any page, simply copy that page's front end code (HTML, JavaScript, CSS files) to your own website.
How to get started: First, let us know your website's domain name. We'll add your website to the list of sites allowed to make API requests. You then have 2 options:
Click on any object to see a list of its properties and methods,
as well as sample code for interacting with the object.
A password is required to view the documentation for assessment-related objects. Please contact us to gain access. If you're curious what the API object documentation looks like, you can view the sample documentation page.
A password is required to view the documentation for person-related objects. Please contact us to gain access. If you're curious what the API object documentation looks like, you can view the sample documentation page.
A password is required to view the documentation for account-related objects. Please contact us to gain access. If you're curious what the API object documentation looks like, you can view the sample documentation page.
Our payment provider is Stripe.
Most of the billing-related objects listed below mirror objects defined in Stripe's API.
A password is required to view the documentation for billing-related objects. Please contact us to gain access. If you're curious what the API object documentation looks like, you can view the sample documentation page.
This api has a Ruby gem! The library can be found here on Github, with the actual gem hosted on RubyGems.org.
Currently the gem is ready only, not supporting creation paths for any models. It does support authentication and different types of queryable interfaces.
Credit for the gem belongs to Jake Yesbeck.