API Docs
Third party developers can incorporate Visrez products such as Floor Plan Builder, Interactive Maps and Virtual Tours into their applications using our API resources. This guide explains the steps required to integrate Visrez products into any third party application with support available from our team.
- To prevent forged requests to steal API keys from users, we restrict the domains in the
return_toparameter (see Authentication below), so we need to authorize your domain. - We require a
integration_partnerparameter when creating a Plan, we’ll provide one for you once we have verified your company account. Please contact our support team directly here.
API Documentation – Production
API Documentation – Testing
Note: The testing environment gets overwritten every night with a copy from production.
Authentication
Each API call require an API key, which is linked to an account in our system. To obtain this API key, send your users to our login URL, adding get_api_key=true and return_to=<your_url> parameters. After user login, we’ll send back to the URL provided in return_to , adding the API key in api_key parameter.
Example:
- Send user to:
https://clients.testing.visrez.com/users/sign_in?get_api_key=true&return_to=https://yourdomain.com/set_api_key - After login, we’ll redirect back to:
https://yourdomain.com/set_api_key?api_key=xxxxxxxxxx
Library
- List Library items for all Orders.
- List Library items for an Order
- List all Library items
- List all Library items filtered by category
Library Packs
Client Accounts
Space Plans
- Create new plan
- Create new plan on a Space Template
- List Space Plans for a Space Template
- List all Plans for a Space
- List all Plans for an Order
- Show a Space Plan