Before you take off with our APIs, read this!
Before you get started with our APIs, it's highly recommended that you familiarize yourself with our concepts and terminology as well as understand how to authenticate and interact with the API.
Service Versions
Each service is versioned separately from other services. This means that the "Contacts" service might be version 6 while the "Customer" service might be version 12. In any case, we will advise you in the documentation for each service what version the documentation is for.
Essential API Concepts and Terminology
In Chassi, you take your Application and execute API endpoints in a given Application Space, which can be either a Definitional Space or an Operational Space either in the Experiment Tenant or in your Production Tenant.
The application GUI has something called the API Spy which can aid you in the development of your application against Chassi endpoints.
When it comes time to use webhooks or manage the operating conditions of each Chassi API, you will use the API Manager.
When connecting to a Chassi API endpoint, you will use OAuth2.0 to authenticate with the credentials found in the Service Account associated with the Tenant and Application Space. Service Accounts always have dual access, so it can access the designated Operational Application Space and always the Definitional Application Space.
To learn in greater detail about how to use a Service Account click here, or if you need to know how Chassi implements OAuth so you can authenticate, click here.
Throughout the API documentation, we will use the following labels to help describe the endpoint in an easy to recognize way:
| Image | Meaning |
|---|---|
 | When this label is present, it means the endpoint can be called in the Definitional Application Space. |
 | When this label is present, it means the endpoint can be called in an Operational Application Space. |
 | When this label is present, it means the endpoint performs an operation that destroys data and may or may not be recoverable. |
 | When this label is present, it means the endpoint is either deprecated or marked for deprecation. In either case, it means the endpoint should no longer be used by your application. |
Every API endpoint uses the following endpoint prefix:
https://{tenantId}.api.chassi.com/{applicationSpaceId}/{service}/{version}
To get the IDs you need for a request, you can either go to one of the Entity Spys in the UI, use the API Spy in the UI or go to IAM & Admin Application Spaces feature and pull up the info. We try and make the IDs very easy to find in the UI. Once you know where to find them, its very easy to obtain them in the future, especially with things like the Entity Spy and the API Spy.
"Try It"
Currently, the "Try It" feature in this documentation is not set up to work, so avoid using it for now. In the future, we will tie the endpoints in the documentation to your Experiment Tenant so you can have an interactive source for your documentation.