API access is available upon request for an additional charge. Please reach out to UNIwise if you wish to learn more about the module.
WISEflow has an extensive API that covers the entire user- and flow creation and management process. With the API, it is possible to build a flexible API client that streamlines the assessment and data management process for feeding and extracting data to and from WISEflow.
API Information
API Integration
An API integration is a custom client built and maintained by the institution using the WISEflow API to manage workflows.
Setting up a simple API client is a good starting point when looking for a quick and straightforward solution to manage one or more workflows. An all-round workflow with user creation, flow creation and grade passback can be split into four milestones:
- Create users in WISEflow
- Create a flow in WISEflow with the default flow settings
- Add one or more user roles to the flow
- Extract and pass back grades to an SIS system
This simple approach covers the most basic needs during the creation and set-up process while leaving the individual flow settings to the manager.
Breakdown of Milestones
Starting with a simple API client, it is possible to gradually add more features as they become necessary for the flow management process, such as:
- Create and manage multiple flows simultaneously
- Customize and automate the flow set-up process with specific user roles, flow settings and allocations
- Automate the grading process by extracting assignments, submissions and passing grades directly to an SIS system
- Extract different log data for analysis and statistics
- Using webhooks to automate tasks
- Flexible and scalable
- Can be fully customised to fit the institution's specific need
- Easy to control and manage flows
- Maintained, built, and supported by the institution
- The API is enhanced on a regular basis and offers very specific endpoints
Authorization
API tokens can be generated, updated, and deleted by the Licence administrator.
On the Licence administration tab, navigate to 'Licence configuration' and then 'API setup'. Here, a Licence administrator can generate both API tokens and 0Auth Clients.
On the token administration page, you have an overview of all available tokens on your licence. You can disable/enable tokens and edit existing ones.
To create a new token, click the 'Create new API token' button:
Creating a new token requires that you give the token a name and a description. It is also possible to add IP filters to the token to limit access. Tokens will automatically expire after one year.
Token expiration
Tokens cannot be extended for more than a year, it is not possible to extend an already expired token
After the token has been created, the full token secret will be displayed:
Be aware!
The token secret is only shown in the modal. Copy and store the token somewhere safe, as the full token secret will not be displayed again!
Once you have copied and stored the token secret somewhere safe, you can close the modal. Your new token will now be displayed in the overview.
Maximum number of tokens
It is not possible to have more than ten tokens per licence.
Clicking 'Edit', lets you edit an existing token:
In the modal, you can change the title, and the description, add additional IP filters and set a new expiration date:
Token expiration
Tokens cannot be extended for more than a year, it is not possible to extend an already expired token
In the overview, you can also enable or disable tokens:
On the 0Auth administration page, you have an overview of all available secrets on your licence. You can create new secrets and edit existing ones.
The 0Auth secret and client Id are used to generate a Bearer token used to authorise API calls.
The secret created here is used to generate a Bearer token.
You can create a new secret by clicking the 'Create new 0Auth secret' button:
Creating a new secret requires that you give the secret a title. It is also possible to add IP filters to the token to limit access.
After the secret has been created, the full token secret will be displayed.
Be aware!
The token secret is only shown in the modal. Copy and store the token somewhere safe as the full token secret will not be displayed again!
Once you have copied and stored the token secret somewhere safe, you can close the modal. Your new token will now be displayed in the overview.
Maximum number of tokens
It is not possible to have more than ten secrets per licence.
You can edit or delete an existing secret by clicking the icon in the overview:
Editing an existing secret lets you change the title and add additional IP filters: