Platform APIs Overview

Use the Platform APIs to access the functionality found in Cloud Elements 2.0 via API rather than the UI. The platform APIs are REST APIs and have predictable, resource-oriented URLs. Cloud Elements 2.0 is a developer platform and provides all the tools a developer needs to create integrations.

We use many standard HTTP features, like HTTP verbs, understood by most HTTP clients. JSON is returned in all responses from the API, including errors. The APIs have predictable, straightforward URLs and use HTTP response codes to indicate API errors.

Viewing the Platform API Documentation

You can use Cloud Elements APIs to interact with the platform and your resources. For example, you can call GET /elements/{keyOrId}/instances to retrieve all authenticated element instances of an element. See the relevant documentation in the API Reference section, or see the documentation for these API collections:

Trying the Platform APIs

From the You can access and try out the Cloud Elements platform APIs from within the platform itself. To access and try the platform APIs, follow these steps:

  1. After logging in to Cloud Elements, click API Docs in the top-right corner. API Docs button
  2. Select an API collection from the API Documentation column. API Docs column
  3. Select one of the endpoints in the main section and then click Try It Out.
  4. Enter any relevant parameters and then click Execute. API Docs Try It Out Execute button