Overview

Cloudpath uses REST API, which is a RESTful API designed for external consumer use, and uses Json Web Tokens for authentication (and allows for auditing). There are three categories of Cloudpath APIs:

• Core Cloudpath APIs - These are APIs run by a Cloudpath administrator. The Cloudpath administrator also creates the tenant portal and management portal listed below. Those portals can be created either via the Cloudpath user interface or by using APIs.
• Tenant Portal APIs (also requires an API Key) - These APIs can be run by the tenant of a property or by the Cloudpath administrator.
• Property Management APIs - These APIs can be run by a member of the property personnel staff (such as a front-desk worker) or by the Cloudpath administrator.
  Note: This is a different set of APIs from Management Portal APIs. "Management Portal APIs" are part of the "Core Cloudpath APIs" and are used by a Cloudpath administrator to create the management portal.

Cloudpath provides REST APIs to enable integration with existing processes or third-party applications. REST APIs allow the system to actively notify external systems (outbound calls) and to be queried and manipulated by external systems (inbound calls).

REST APIs are resource-based, and support the following HTTP verbs:

• GET (to get information about a resource)
• POST (to create a resource)
• PUT (to change the state of a resource)
• DELETE (to delete a resource)

REST APIs also return errors by using HTTP return codes. Refer to Return Codes and Error Response Format.

Root URIs Used For Cloudpath APIs:

The various root URIs are of the following form:

• Core Cloudpath APIs: <Cloudpath FQDN>/admin/publicApi
  Note: The following root URI has been used prior to Cloudpath 5.9 (and still works in 5.9), but will be deprecated in future releases: <Cloudpath FQDN>/admin/apiv2/{APIKey}
• Tenant Portal APIs: <Cloudpath FQDN>/admin/rest/tenant/{apiKey}
• Property Management APIs: <Cloudpath FQDN>/admin/rest/propertyMgmtPortals/{mgmt_portal_guid}