Client
Work with Clients.
| API | Description |
|---|---|
| GET v1/clients |
Returns an array of all clients |
| GET v1/clients/{id} |
Retrieves a client by their id |
| GET v1/clients/{id}/keys |
Retrieves all client keys for a client by their id |
| POST v1/clients/{id}/create-clientkey |
Add new Client Key to Client |
| POST v1/clients/{id}/remove-clientkey |
Remove Client Key to Client |
| POST v1/clients |
Creates a client |
| PUT v1/clients/{id} |
Creates a new client or updates an existing client |
Exception
| API | Description |
|---|---|
| POST v1/Exception/LogJavaScriptError |
No documentation available. |
Debug
Debug the service itself. Check online status, authentication, server time, etc.
| API | Description |
|---|---|
| POST v1/debug/AnonymousPing |
Returns true, no authentication required |
| POST v1/debug/Time |
Returns site time, authentication required |
| POST v1/debug/AuthenticatedPing |
Returns true, authentication required |
| POST v1/debug/ErrorPreview |
Generates a handled error and returns it |
| POST v1/debug/ServerErrorPreview |
Throws an unhandled error |
| POST v1/debug/WhoAmI |
Displays the name of the authenticated client |
Participant
Work with a Participant. Requires Participant Key
| API | Description |
|---|---|
| POST v1/Participant/{id}/validation |
Creates a new participant or updates an existing participant and validates the Name and TIN combination |
| GET v1/Participant/{id}/validation |
Gets a participant's validation status |
Theme
Work with themes.
| API | Description |
|---|---|
| GET v1/themes |
Returns an array of all themes |
| GET v1/themes/{id} |
Retrieves a theme by their id |
| POST v1/themes |
Creates a theme |
| PUT v1/themes/{id} |
Creates a new theme or updates an existing theme |
| GET v1/themes/{cid}/{id}/companyLogo |
Get a CompanyLogo.png |
| GET v1/themes/{clientid}/{id}/programLogo |
Get a ProgramLogo.png |
| GET v1/themes/{clientid}/{id}/frameBackground |
Get a FrameBackgroundImage.png |
| POST v1/themes/{id}/upload-companyLogo |
Upload a Company Logo to a Theme |
| DELETE v1/themes/{id}/companyLogo |
Delete a company logo |
| POST v1/themes/{id}/upload-programLogo |
Upload a Program Logo to a Theme |
| DELETE v1/themes/{id}/programLogo |
Delete a program logo |
| POST v1/themes/{id}/upload-frameBackgroundImage |
Upload a Frame Background Image to a Theme |
| DELETE v1/themes/{id}/frameBackgroundImage |
Delete a Frame Background Image |
ParticipantV2
Work with a Participant. Requires Participant Key
| API | Description |
|---|---|
| POST v2/Participant/{id}/validation |
Creates a new participant or updates an existing participant and validates the Name and TIN combination |
| POST v2/Participant/{id}/collection |
Creates a new participant or updates an existing participant and collects the Name and TIN combination |
| GET v2/Participant/{id}/collection |
Gets a participant's collection status |