Connecting iSAMS

Step 1: Start the Integration Flow in Edlink

1. Click the integration link provided by your learning app.
2. Create an Edlink account if you don't already have one.
   If you've connected an app to Edlink before, log in with your existing account.
3. Select iSAMS from the list of available data sources.
4. Choose your preferred data storage region.
5. Enter your iSAMS server URL (for example https://<your-domain>.isams.cloud).

Step 2: Create Batch API Credentials in iSAMS

Edlink syncs data from iSAMS via the Batch API. Create a Batch API client and allocate the methods Edlink needs.

1. Log in to iSAMS as an administrator.
2. Open the Control Panel and navigate to API Services Manager.
3. Create a new Batch API client for Edlink.
4. Grant the client the apiv1 OAuth scope.
5. Allocate the rostering Batch methods Edlink requires, including at least:
   • School: years and terms
     • School_GetAllYears
     • School_GetSchoolTerms
   • Estate: buildings and classrooms
     • Estate_GetAllBuildingsAndClassrooms
   • Curriculum: departments, subjects, courses, classes, class students, cycles, types, and blocks
     • Curriculum_GetDepartments
     • Curriculum_GetSubjects
     • Curriculum_GetCourses
     • Curriculum_GetClasses
     • Curriculum_GetClassStudents
     • Curriculum_GetCycles
     • Curriculum_GetTypes
     • Curriculum_GetBlocks
   • HR: current staff
     • HumanResources_GetCurrentStaff
   • Pupils: current pupils
     • Pupil_GetCurrentPupils
   • Contacts: advanced contacts
     • ContactAdvanced_GetContacts
   • Timetable: timetable structure
     • Timetable_GetTimetableStructure
   • Control panel: contact type global list
     • ControlPanel_GetContactTypeGlobalList
6. Copy the generated Client ID and Client Secret.

Step 3: Enter Your Credentials in Edlink

1. Paste the Client ID into the Edlink integration page.
2. Paste the Client Secret into the Edlink integration page.

Step 4: Complete the Integration

1. Select the timezone your school is located in (if prompted).
2. Click Validate Configuration, then click Continue Setup once your configuration is validated.

Validation checks that Edlink can obtain an OAuth token and that each required Batch method is allocated and reachable. Methods that return no data may surface as warnings rather than hard failures.

Well Done!

Your iSAMS source is now connected to Edlink. Once validated, your organization's data will sync with the Edlink dashboard within 24 hours.

Any Questions?

If you have any questions or encounter issues, please contact our support team. We'll respond within 24 business hours.