The API Explorer serves as a comprehensive reference and a powerful tool for generating customized code and testing requests, making it easier for developers to integrate our software into their applications. With this API, you can access nearly all the functionality within CiiRUS available to Property Managers, enhancing your application's capabilities and user experience.

Logging In

To begin, log in to the Partner-API Explorer using your CiiRUS Username and Password (MC Username and Company Password). This will pre-populate your API Authorization Credentials and grant you access to various features.

Managing Your Credentials

If your credentials did not automatically populate, no worries! You can manually enter your API Username and API Password in the Authorization section to proceed with your API exploration.

📘
Need Help?
In case you are unsure about your credentials or encounter any issues during the process, our dedicated support team is here to assist you. Please reach out to CiiRUS Support by submitting a new support request by clicking - HERE

Generate a Request

The Partner-API Explorer empowers you to interact with the various API endpoints seamlessly. Follow these steps to generate a request:

Find the API you wish to explore from the available options.
For each API, you will have specific body parameters to configure. Enter the required values for each parameter, and watch the code dynamically update as you provide the information.
If you prefer a specific programming language, simply select your desired option.

Send a Request and Generate a Response

Once you have set up your request, it's time to send it and receive your response:

Before sending the request, ensure that all necessary parameters are correctly entered to avoid errors.
Click "Try It" to send the request.

The response will be displayed in the right-most column. In case your request encounters any issues, don't worry; simply troubleshoot the problem and try again.

The response may appear collapsed to optimize visibility. If so, click on the ... within the response to expand the section and view its contents in detail.

We Value Your Feedback

Your feedback is vital in our continuous efforts to enhance your experience with our Partner-API Explorer. If you have any suggestions or concerns, feel free to use the Suggest Edits button located at the top of the page. We are committed to serving you better and ensuring that your journey with our Partner-API Explorer is as smooth as possible.