Skip to main content

Set up a single Batch API key using the iSAMS API

Request and configure a single Batch API key in iSAMS to connect My School Portal with your iSAMS data.

Written by Cristina Gruita

The iSAMS API allows you to connect My School Portal with your school data using a Batch API key. You’ll need administrator access in iSAMS to complete the process. This setup involves requesting the key and then configuring it for your portal.


Request a new Batch API key

  1. Log into iSAMS.

  2. On the left, click Administration, then click iSAMS Control Panel.

  3. Click API Services Manager.

  4. On the right, click Manage Batch API Keys.

  5. Click Request/Create Batch API Key. The Integrator Properties pop-up appears.

  6. Enter My School Portal as the Integrator Name.

  7. Enter Single API Key as the Product Name.

  8. Click Save & Close.

After you save, iSAMS will send you an email containing your Client ID and Secret. Keep these details safe, as they are required later in the setup process.


Configure your Batch API key

  1. Log into iSAMS.

  2. On the left, click Administration.

  3. Click iSAMS Control Panel.

  4. Select APU Services Manager.

  5. On the right, click Manage Batch API Keys.

  6. Find your new API key in the list, using the Integrator Name and Product Name entered earlier.

  7. On this row, in the second column from the right, click edit API Key. A pop-up will appear.

  8. Select the checkboxes for each batch method required.

    📌Note: Please refer to your documentation to confirm which batch methods you need for My School Portal.

  9. Review the API Key Cache Expiry field. Adjust this setting if you want data updates to be available more quickly in your portal.

  10. After selecting the required options, click Save & Close.


Complete your My School Portal setup

Once the above steps are completed request to speak to an agent via the Digital Assistant.

Did this answer your question?