Page tree
Skip to end of metadata
Go to start of metadata

The CMIX API is a JSON based, REST API. The whole CMIX platform is built on top of the several services offered by the CMIX API.

 

Need some help? Contact support@cmix.com and we'll help you get started!

What services does the CMIX API provide?

The CMIX Survey Platform API is split into three different services, each with specific concerns:

 

On this page:

Authentication

Click here for Swagger docs

This service handles authentication against the CMIX platform and uses the OAuth 2.0 authentication Protocol. Only the initial access token negotiation, and any subsequent session refresh will happen against this endpoint.

Normally, API clients will use the password grant to authenticate as a specific user, unless they are acting as a super user for admin level actions. For the password grant flow, you'll require two pairs of credentials:

1. Client set: client_id/client_secret

The client set will be unique for your Account within our system. In a way, it's considered your master account. You can use this to build your own Back-End and Front-End applications that will then consume our API.

2. User set: username/password

This uniquely identifies a user within CMIX. You can tie this to users in your own applications so there's a 1 on 1 relationship between them. This is useful to synchronize permissions, limit access and for Single Sign On.

Survey

Click here for Swagger docs

The survey service allows you to get and modify a survey's definition. The definition consists of all sections, pages, questions, variables, and responses, as well as other control objects such as quotas, logic, etc.

Reporting

Click here for Swagger docs

The reporting service can be used to fetch respondent data based on the given filters. Other reporting endpoints for getting frequency counts are also available.

File Processing

Click here for Markup docs

The file processing service's role is to read and write human readable files that contain parts of the survey definition. These can be survey definition (markup), translations, and quotas.

The links provided above are for our Sandbox environment. If you are ready for a production integration, please contact support@cmix.com.