TASS (via API) access requirements and configuration

In order to synchronise data from TASS via the TASS API, we'll ask you to provide us with some important information.

➡️ Minimum access requirements

➡️ Generating API keys

➡️ Granting API access

On the API configuration screen in TASS, please provision access to the APIs listed below.

Every school has a domain of [TASS.web] (*http://tass.web/) server allocated to them and a unique Company Code with the TASS API. In order to grant the required access, please provide Intellischool with your Company Code. This is usually a number, often leading with zero - e.g. "01".

The TASS API is organised into modules. Intellischool gathers data from specific modules with specific version numbers. For each of the 'Minimum access requirements' modules listed below, we’ll ask you to provide both the App Code and the Token Key.

➡️ Minimum access requirements

➡️ Generating API keys

To generate API keys for use with Intellischool, you'll need to be logged in to TASS as an administrator.

Before generating any API keys, be sure to make note of the Company Code that your school is using in TASS. This is usually a number, often with a leading zero - e.g. "01".

Once you have your Company Code, follow the below steps:

1. Navigate to System Admin > Utilities > API Gateway Maintenance.
2. Follow the prompts to generate a new API key pair for each of the APIs that you need Intellischool to connect to.
3. Submit this information via OneTimesecret to your school’s Intellischool Engagement Manager, or to help@intellischool.co. 

➡️ Granting API Access

Security Roles are maintained in the TASS application under System Admin > Users > Security Role Permissions.

• Create a new role, and assign it the name 'intellischool_api' or something similar.
• When editing the permissions for the new role, make sure the new role you've just created is selected.
• Expand the relevant sections and assign the permissions listed below by ticking the relevant boxes.
• Navigate to API Gateway Maintenance, and create 5 new API applications - one for each of the below configurations:

Once the API applications have been created, you should see a summary similar to the below:

• The final step is to provide us with a summary of the 4 new applications using this template document - available here via the TASS website, and also available here as a PDF download.