API Documentation

How To Use The CiiRUS-API Explorer

Overview

The CiiRUS-API Explorer is a convenient tool to help you build and visualize API requests tailored to your business needs. While the Explorer provides sample responses and request structures, live API testing must be performed from a whitelisted IP address using tools like Postman, Insomnia, or your preferred API client.

🚧

Due to security requirements, the CiiRUS-API only accepts requests from IP addresses that have been explicitly whitelisted. The API Explorer is not intended for full end-to-end testing of live responses. Use it to construct and preview your requests, then test them externally from a whitelisted environment.

What You Can Do with the Explorer

  • Browse available endpoints in the CiiRUS-API
  • View and customize request bodies by modifying parameters to suit your integration
  • Generate sample request code in multiple languages (e.g., cURL, Python, JavaScript)
  • Use as a reference for required fields, data structures, and parameter formats

Logging In to the Explorer

To get started:

  1. Go to the CiiRUS-API Explorer.
  2. Use your CiiRUS MC Username and Company Password to log in.
  3. Your API credentials (API Username and API Password) will auto-populate for use in the authorization header.
    1. If they don’t, you can manually enter them under the Credentials section.

🚧

🔐 Reminder: These credentials are different from your standard login. If you’re unsure of your API credentials, contact CiiRUS Support for assistance.

Authentication Overview

All requests to the Partner API must include an Authorization header using Basic Auth. This header must contain a Base64-encoded string in the following format:

APIUsername:APIPassword

When Base64-encoded, this string should be added to the header like this:

Authorization: Basic BASE64ENCODED_STRING

📘

💡 You can use the Explorer to generate this automatically once you've logged in, or manually encode your credentials using any secure Base64 encoder.

Building a Request

  1. Select an endpoint from the navigation menu.
  2. Input values into the Query or Request Body Parameters section.
  3. Select your preferred code sample language (if needed).
  4. Use the generated code as a template in your API testing tool (e.g., Postman or Insomnia).

Testing the Request (Outside of the Explorer)

Once you've built your request:

  • Open your API client (Postman, Insomnia, etc.)
  • Use the request URL, body, and headers generated by the Explorer.
  • Ensure your request is made from a whitelisted IP address—this is required for authentication to work.
  • Review the response and adjust your request parameters as needed.

Troubleshooting & Support

If you're having trouble:

  • Confirm your IP address is whitelisted with CiiRUS.
  • Double-check that your Authorization header is formatted and encoded correctly.
  • Reach out to our team if you have questions or if you're unsure about how a specific endpoint functions.

For additional help, submit a support request here.

We Value Your Feedback

If something doesn’t look right or you have ideas for improving this tool, click "Suggest Edits" at the top of each page. Your input helps us improve the Partner-API Explorer and overall developer experience.