How to Integrate with School Passport?

School Passport Sandbox environment offers a controlled, safe, and simulated environment for Application Partners (Vendors) to test their integrations before deployment in the live educational setting. This guide will provide you with step-by-step instructions on how to test the School Passport environment from both the district's side, enabling you to import your own data, and from your application's viewpoint.

Overview

Once you become a member of GG4L, you will get access to a full set of data integration mechanisms and SSO technologies. This article provides a brief overview of the integration steps:

1. Roster data integration: Completing the School Passport Request Form and establishing data integration with the School Passport platform on the Sandbox environment.
2. SSO and authentication: Implementing Single Sign-On (SSO) and authentication method for customers to authenticate them into your application.
3. Application usage: Once data integration and SSO/authentication are in place, organizations can seamlessly work with your applications and invite customers.

Accessing School Passport Sandbox

To begin the testing process, please complete the School Passport Sandbox Account Request Form. Our Onboarding Team will then create a Sandbox environment specifically for you and provide you with access to it.

Obtaining Sandbox grants you access to two testing accounts: Vendor and District. This access is important for getting familiar with your application with School Passport from both perspectives.

Testing from the district side

To begin testing from the district side, follow these steps:

1. Access your district account: Log in to your district account within School Passport Sandbox using the provided credentials.

2. Import data via SFTP: School Passport allows you to import your district data via Secure File Transfer Protocol (SFTP). Upload your prepared district data using SFTP to populate your district account with the necessary information.

3. Connect to your test application: Once your data is imported, send data sharing request to your application to integrate it within the district's educational system.

4. Establish the connection: When you accept the request within your application, connections will be established and data sharing process begin.

Testing from your side

After successfully importing data, start to test your integration from your side. You can run various test scenarios, including roster data synchronization, and PII Shield.

1. Access your vendor account: Log in to the provided Vendor account within the School Passport Sandbox environment.

2. Accept data sharing: You'll receive data sharing from your district account. Accept this request to establish the connection between your application and the imported district data.

3. Initiate testing: Upon accepting the request, proceed with testing your application. Verify the functionality and compatibility of your application within the district's environment.