On this page, you will find the following information:
Google Drive Integration
- Folder Actions
- Add to My Links
- View Files
- RSS
Are you sure you want to remove this component?
Are you sure you want to remove this component?
Please follow the setup instructions below to configure the Google Drive API for Schoolbox to use. Please contact the Schoolbox Support Team (support@schoolbox.com.au) to assist, if you encounter issues.
1. Sign into Google Services with the Google account that you wish to link Schoolbox to for integration (one setup per school).
NOTE: Users can see the email address of the Google account during Authorisation request process.
2. Navigate to: https://console.developers.google.com.
3. Click the hamburger (3 line) menu in top left corner and select 'IAM & Admin'.
4. Click 'Create Project'.
5. Give your project a name and Project ID.
NOTE: You cannot change the Project ID later.
6. Click the hamburger menu in top left corner and select 'API Manager' and then 'Credentials'.
7. Select 'OAuth consent screen'.
8. Fill in the details on the OAuth consent screen:
- Email Address
- Product name shown to users: Enter the name of your school's Schoolbox instance. (E.g: eLY, Caleb, eCat etc...).
- Homepage URL: Enter your school's public-facing URL for Schoolbox, includng protocol. (E.g: https://myschool.school.edu.au).
- Product logo URL: Enter the following URL, changing the domain to your school's domain. (E.g: 'canary' to 'demo': https://canary.schoolbox.com.au/images/logo.php?logo=skin_logo_square&size=apple120).
- Privacy policy URL: Enter {schoolbox domain}/policy.php. (E.g: http://demo.schoolbox.com.au/policy.php).
- Terms of service URL: Set to the same as the Privacy Policy URL in previous step.
9. Click 'Save'. You will be taken back to credentials.
10. Click on 'create credentials' drop down and select 'OAuth client ID'.
11. Add credentials for a new OAuth Client ID:
- Application type: Select 'Web Application'.
- Name: Enter your school's name for your Schoolbox instance.
- Authorized Javascript Origins: One per line, every different subdomain the school uses for Schoolbox (ensure to add both HTTP and HTTPS editions of every domain). E.g.:
- Authorized Redirect Headers: Copy-paste same content of the above “origins” field.
12. Click 'Create'. This will generate your client ID and client secret. Copy these details, we recommending labelling them carefully with 'client ID' and 'client secret'. These will be needed later.
13. Click 'OK'.
14. You will now need to create a new API Key. Select 'Browser Key'.
15. Fill in the details to create browser API key:
- Name: Schoolbox Key
- Accept request from these HTTP referrers (web sites): Fill in HTTP Referrers with: *.{school domain}* (E.g. *.school.edu.au/* ).
16. Click 'Create'. Your API key will then appear. Record your API key.
17. Click 'OK'.
18. Navigate to API Manager > Library > Google APIs.
19. Search 'Drive API'.
20. Select 'Google Drive API' by clicking on the name.
21. Click 'Enable'.
22. Naviagte back to API Manager > Library > Google APIs, as in Step 18.
23. Search 'Picker API'.
24. Select 'Google Picker API' by clicking on the name.
25. Click 'Enable'.
26. Navigate to API Manager > Dashboard > Enabled APIs.
27. Click the cog icon next to Google Drive API to configure it.
28. Fill in the form. All non-mandatory fields can be left blank:
- Icons: Upload your equivalent of https://canary.schoolbox.com.au/images/logo.php?logo=skin_logo_square&size=apple120 (from earlier) into every size of Application Icon and Document Icon.
- Drive Integration: Check the box for Authentication → Automatically show OAuth 2.0 consent screen when users open my application from Google Drive.
- Client ID: Copy the Client ID from Step 12 into the Client ID field, excluding the .apps.googleusercontent.com suffix.
- Open URL: Enter {schoolbox domain}.
29. Click 'Save'.
30. In a new tab or window, go to your school's Schoolbox instance and navigate to Admin > Settings > 3rd Party Services.
31. Enter the Google Apps API Key Google Apps Client ID into the relevant fields.
NOTE: Do not include the .apps.googleusercontent.com suffix in the Client ID.
NOTE: You can find these again by navigating back to: APIs & Auth > Credentials.
Are you sure you want to remove this component?
- If you are accessing Schoolbox via a single word domain (E.g. http://schoolbox/) instead of the full domain (E.g. http://schoolbox.school.edu.au/), the Google Drive integration will fail to display. This is due to restrictions provided by the Google Drive API.
- If there is a reverse proxy sitting between users and Schoolbox, you may need to enable an extra header (Authorization) to be forwarded through to Schoolbox instead of being stripped out. The symptom of this is after selecting the file in Google Drive, it gets permanently stuck on the message "Collecting files from Google".
Are you sure you want to remove this component?
You should now be able to test the Google Drive integration by clicking on a file drop zone or file upload area, selecting “Google Drive” from the available options and following the prompts to connect.