Generate and copy iSAMS API key
- Log in to your iSAMS account
- Create a custom group with all the students you'd like to import
- Navigate to the 'API Services Manager' by going from Control Panel Home > External Web Services > API Services Manager.
- In the top left you will see a button with 1 of 2 options.
If it says Create Batch API Key you're on an older version of iSAMS. Continue with If it says Request Batch API Key you're on a newer version of iSAMS. C
- Click Create Batch API Key.
- Go to the Batch Methods tab in the popover.
- Select all the relevant methods
- Pupil Manager Datasets → Current Students
- HR Manager Datasets → Current staff
- Exams Manager Datasets → Exam Results
- Teaching Manager Datasets → Teaching Sets
- Teaching Manager Datasets → Teaching Set Lists
- Go to the Student Filters tab.
- Select the custom groups you created earlier.
- Go to the Key Properties tab.
- Copy the API key by highlighting the text, right-clicking and selecting
- We suggest you name your key
- Click Request Batch API Key
- Check your email. You should receive a support email from iSAMS via Zendesk.
- Follow the link to the support ticket in the email.
- Request your key. If you only want to provide access to your custom student groups or certain data methods, mention those in your request. The relevant methods are:
- Pupil Manager Datasets → Current Students
- HR Manager Datasets → Current staff
- Exams Manager Datasets → Exam Results
- Teaching Manager Datasets → Teaching Sets
- Teaching Manager Datasets → Teaching Set Lists
Next,
- Log in to BridgeU
- Click
- Paste the API key in the field labelled API Key.
- Click SAVE button.
- Copy the beginning of the URL in the browser's address bar. The structure should be "isams.example.ac.uk", where "example" is your school name. To copy, highlight the text, right-click and select Copy.
- Log in to BridgeU.
- Click School Settings in the left navigation.
- Click iSAMS in the sub-navigation.
- Paste the iSAMS URL in the field labelled URL of iSAMS instance.
- Click SAVE button.
If you have completed all the steps above, your iSAMS integration is complete 🚀.