Using the API

Overview This article provides an overview of the CIMcloud API.  It covers the following topics: “API” Defined (a Few Concepts)...

This article provides an overview of the CIMcloud API Framework with examples.  This article is intended to be a technical...

To help orient you with the API Framework, the following definitions will be used throughout: App Authorizations: Contains credentials to...

Overview This section covers a few technical basics related to the CIMcloud API. The body of all requests are in...

Before you can begin calling the CIMcloud API, you’ll need to create a App Authorization.  This is located in your...

Once your CIMcloud Authorization is created with Resources assigned, an automated process will generate documentation for the endpoints available. The...

Finding Your Authentication Credentials Head to the backend of your website to obtain credentials: Login to the Worker Portal Search...

Overview The Refresh Token update allows integrators to obtain new JSON Web Token (JWT) bearer tokens without repeatedly sending their...

API Health Checks The CIMcloud API supports the following health checks for our API Framework to monitor status of the...

Overview GET requests allow you to retrieve data from the CIMcloud API / platform. Results can be filtered by Searchstrings...

The default records returned on a GET request is 50 results.  You can use pagination to cycle through results with...

Overview This article provides technical details on how to filter the data records returned when making a GET call to...

Complex resource types allow highly customizable queries to manipulate records within the Worker Portal -> Resources Add-Edit page. To allow...

POST Requests Overview POST requests allow you to add or edit data in the CIMcloud platform via the API If...

Full List of Core Resources / Endpoints These are the standard API resources available on CIMcloud sites with the API...

Overview The OrderPassThrough endpoint allows you to create an order along with its details in the CIMcloud platform via the...

Overview This endpoint generates a Session for a customer and returns a new Bearer Token with that Session attached. Requests...

HTTP status codes the server can generate in response to HTTP requests via the API Framework: 200 OK: Your request...

Overview Make, formerly Integromat, is a third party iPaaS solution that simplifies moving data between software platforms. The CIMcloud Make...