CogniFit
🚀 Welcome to the CogniFit API Workspace This workspace will help you integrate CogniFit’s cognitive assessments, training, and games into your website or application. Here, you'll find detailed documentation, examples, and guides to get started quickly.
13 subscribers
35 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
CogniFit endpoints
| Method | Endpoint | Description |
|---|---|---|
| Quickstart | ||
| GET |
healthCheckCredentials /health-check |
This endpoint allows you to perform a health check. |
| GET |
supportedLocales /supported-locales |
This endpoint returns the list of supported locales that can be used in the locale parameter. |
| Configuration | ||
| POST |
getCallbackUrls /configuration/callback-url |
This endpoint returns the list of callback URLs configured for your account. |
| POST |
addCallbackUrl /configuration/callback-url/add |
This endpoint add a new callback URL to your account. |
| POST |
deleteCallbackUrl /configuration/callback-url/delete |
This endpoint delete a existing callback URL in your account. |
| User registration | ||
| POST |
createNewUserAccount /registration |
This endpoint is used to register a new user account under your client account. |
| POST |
associateExistingUserAccount /user-authenticate |
This endpoint is used to associate an existing CogniFit user account with a partner application. If the user already has a CogniFit account, redirect them to this endpoint. If… |
| User authentication | ||
| POST |
issueUserAccessToken /issue-access-token |
The `issue-access-token` endpoint is used to obtain an access token for a user. It must be sent back to CogniFit before it expires. |
| POST |
useAccessTokenToAccessCognifit /partner/{clienthash} |
After obtaining a user access token, it must be used before it expires in request. Send the access token to this endpoint using one of the following endpoint domain: 1. To the… |
| User manager | ||
| POST |
updateUser /update-user |
Updates user account information. |
| POST |
deactivationUser /patient/deactivate |
Allows to deactivate users and free their licenses. As long as users are deactivated, their cognitive information can not be reached nor can they log in CogniFit. |
| POST |
activationUser /patient/activate |
If a user was previously deactivated, this method will set it to activated. Users need to be activated to log in CogniFit. Activate a user is not allocating any license or… |
| POST |
userGrantTrainingSubscription /subscription/set |
Allows to activate monthly recurring subscriptions for users. User will have access to all training programs and all games. By default, the personalised training will be set as… |
| POST |
userCancelTrainingSubscription /subscription/remove |
Allows to deactivate monthly recurring subscriptions for users. User will have access until the end of his subscription period. After that subscription will not be renewed and… |
| DELETE |
userAccountDeletion /delete-user |
Allows to delete user accounts. User data would be removed. User would not be able to access CogniFit anymore with this account. The partner would not be able to access user… |
| POST |
userListServerServer /get-users-list |
Get the list of your active users with active training licenses and allocated assessment licenses. |
| Catalog | ||
| GET |
skillsList /skills |
List of cognitive skills measured and trained by CogniFit. |
| GET |
taskSkillsList /task-skills |
List of task skills measured and trained by CogniFit. |
| GET |
assessmentList /programs/assessments |
List of allowed assessment keys to use when setting a program. |
| GET |
singleTaskAssessmentList /programs/assessment-tasks |
List of allowed task assessment keys to use when setting a program. |
| GET |
questionnairesList /programs/questionnaires |
List of allowed questionnaires assessment keys to use when setting a program. |
| GET |
trainingList /programs/trainings |
List of allowed training keys to use when setting a training program. |
| GET |
brainGameList /programs/tasks |
List of allowed brain games keys to use when setting a training program. |
| GET |
trainingTaksList /programs/training-tasks |
List of training task keys with metadata to use on the pre-training screen, allowing you to display and explain each cognitive task before the user begins their session. |
| Launch activities | ||
| POST |
setTaskProgram /partner/{clientHash} |
Sets task programs for the specified user. The user is automatically logged into CogniFit to complete the assignment process without manual intervention. |
| POST |
setTrainingProgram /partner/{clientHash} |
Sets training programs for the specified user. The user is automatically logged into CogniFit to complete the assignment process without manual intervention. |
| Activity and evolution report | ||
| POST |
getHistoricalSkills /get-historical-score-and-skills |
Return the skill evolution of the user sorted from most recent to least recent. Skill scores are updated after each training session or assessment. This method could be used to… |
| POST |
getHistoricalPlayedGames /get-historical-played-games |
Return the skill evolution of the user sorted from most recent to least recent. Skill scores are updated after each training session or assessment. This method could be used to… |
| POST |
getAssessmentValues /user-info/get-assessment-values |
Return the assessment values calculated for the user after an assessment session. This method could be used to show to a user his cognitive historical but it is not build for… |
| POST |
getAssessmentReportFiles /user-info/get-assessment-report |
Return the assessment report or assessment reports created after a user assessment session. On success pdf file or zip file with pfd files will be returned. If the reports are… |
| POST |
getAssessmentReportUrls /user-info/get-assessment-report-url |
Return the assessment report url or assessment report urls created after a user assessment session. If the reports are being built and they are not an error 1601 will be… |
| POST |
getAssessmentReportUrlsWithMetadata /user-info/get-assessment-report-url-with-metadata |
Return the assessment report url or assessment report urls created after a user assessment session. If the reports are being built and they are not an error 1601 will be… |
| Associates registration | ||
| POST |
createNewAssociateAccount /registration/new-associate/register |
It is possible, through the API, to create client accounts under the main client account. This process will generate distinct credentials for each client account. You can then… |
| POST |
createNewUserAccountWithAlternativeIdentity /registration |
This endpoint is used to register a new user account under your API integration with alternative identity (Other associated account) |
| Error messages | ||
| GET |
errors /errors |
List of codes errors and message errors the application can throw. |
CogniFit pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
| PRO Recommended | $29 / month | 30 / minute |
|
| ULTRA | $99 / month | 60 / minute |
|
| MEGA | $250 / month | — |
|
