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.
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.
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.
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.