Setup your iSAMS Integration

Steps
  1. Generate and copy iSAMS API key
  2. Paste and save your API key on BridgeU
  3. Find and copy your iSAMS URL
  4. Paste and save iSAMS URL on BridgeU
 

Generate and copy iSAMS API key

  1. Log in to your iSAMS account.
  2. Create a custom group with all the students you'd like to import. See iSAMS documentation on creating custom groups.
  3. Navigate to the 'API Services Manager' by going from Control Panel Home > External Web Services > API Services Manager.
  4. 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 these instructions for generating your API key manually.                                                        If it says Request Batch API Key you're on a newer version of iSAMS. Continue with these instructions for generating your API key through iSAMS customer support.

Generate your API key manually

  1. Click Create Batch API Key.
  2. Go to the Batch Methods tab in the popover. This is where you can set which data BridgeU can import.
  3. 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
  4. Go to the Student Filters tab.
  5. Select the custom groups you created earlier.
  6.  Go to the Key Properties tab.
  7. Copy the API key by highlighting the text, right-clicking and selecting "Copy".
  8. We suggest you name your key “BridgeU API Key”, in the API Key Name field, so you can identify it more easily in the future. Optionally, you could describe the methods and groups the key gives access to in the Description field.

 Next, save your API key on BridgeU.com.

 

Generate your API key through iSAMS Customer Support

  1. Click Request Batch API Key
  2. Check your email. You should receive a support email from iSAMS via Zendesk.
  3. Follow the link to the support ticket in the email. 
  4. 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, save your API key on BridgeU.com.

Paste and save your API key on BridgeU

  1. Log in to BridgeU
  2. Click School Settings in the left-hand navigation.School_Settings.png
  3. Click iSAMS in the sub-navigation.
  4. Paste the API key in the field labelled API Key.Paste_API_Key.png
  5. Click SAVE button.

Find and copy your iSAMS URL

  1. Log in to iSAMS.
  2. 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.isams.jpg

Paste and save your iSAMS URL on BridgeU

First, find and copy your iSAMS URL.

  1. Log in to BridgeU.
  2. Click School Settings in the left navigation.School_Settings.png
  3. Click iSAMS in the sub-navigation.
  4. Paste the iSAMS URL in the field labelled URL of iSAMS instance.URL_of_iSAMS_instance.png
  5. Click SAVE button.

If you have completed all the steps above, your iSAMS integration is complete 🚀.

Was this article helpful?
1 out of 1 found this helpful

Related articles