Overview

Cloudpath uses REST API, which is a RESTful API designed for external consumer use. It uses JSON Web Tokens for authentication and supports 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 through API calls.
  • Tenant Portal APIs - 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.

Note: Basic knowledge of REST API and JSON format is necessary.

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)
  • Be queried and manipulated by external systems (inbound calls)

.

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

  • GET: Get information about a resource
  • POST: Create a resource
  • PUT: Change the state of a resource
  • DELETE: Delete a resource

In multi-tenant, Cloud-hosted deployments of Cloudpath, the following default rate limits are enforced to ensure optimal performance and fair usage across tenants:

  • API Request Limit: Each account or tenant is restricted to a maximum number of 180 API requests per minute. Additionally, API based authentication token requests are limited to 10 authentication token requests per minute per account or tenant. Rate limiting is enforced only in Cloudpath Cloud-Hosted deployments. On-premises or self-hosted instances do not apply these rate limits.
  • Maximum Page Size: API responses are capped at a maximum of 1000 records per request.
  • API Token Request Limit: Each account or tenant is restricted to a maximum number of 10 API token requests per minute.

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

Root URIs Used For Cloudpath APIs:

The various root URIs follow the following format:

  • 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 is deprecated in releases later than: <Cloudpath FQDN>/admin/apiv2/{APIKey}
  • Tenant Portal APIs: <Cloudpath FQDN>/admin/rest/tenant/
  • Property Management APIs: <Cloudpath FQDN>/admin/rest/propertyMgmtPortals/{mgmt_portal_guid}
Parent topic: Cloudpath REST API Basics