Enable API Access

Users with Global Administrator permissions can enable the XiO Cloud REST API functionality directly from the XiO Cloud portal.

The XiO Cloud REST API binds to the XiO Cloud server as a new transport interface (much like a direct transport interface or a serial join interface). The REST API layer provides a translation from the XiO Cloud server. Web server requests are stateless, and all stateful information is maintained between the XiO Cloud REST API layer and account, group, and device data. For more information, refer to the XiO Cloud Service API microsite at https://developer.crestron.com.

NOTE: Certain API functions (including claiming third-party devices and viewing current and historical data for devices, rooms, and desks) require an XiO Cloud Premium subscription.

To enable API access from the portal:

  1. Select the gear icon Gear Icon on the left side of the screen.
  2. Select Account Settings.

    3. SETTINGS Menu

    SETTINGS Menu

  3. Within the Profile tab on the right side of the screen, expand the Details accordion, and then turn on the Enable API Access toggle.

    4. Profile Tab - Details Accordion

    Profile Tab - Details Accordion

  4. Enter the administrator’s name and email address in the appropriate text fields.
  5. Tap Save Changes on the top right of the accordion. An API authentication key is displayed next to Api Subscription Key.