Pre-requisites:
1. The user who sets up the account needs to have access to the Google Cloud Console within the school/district workspace. They must be part of the organization for which they wish to set up the web client. You can check this permission by visiting Google Cloud console and logging in with your workspace account. You will be able to see that you are part of a workspace on the top right corner, like so
2. While not absolutely necessary, it's preferable that the user setting up the web client, permissions, and scopes has admin access. This will make personal branding and submissions for review more straightforward in the future.
Creation of the Project and the Web Client
A project within Google APIs contains all the settings, configurations, and permissions that are necessary for communicating with other applications (in our case, with Kira)
A web client can be thought of as a “container” that can speak with the Google Classroom setup in your workspace and allow it to talk with Kira Learning and its services. It lives within a project and helps the project securely communicate with Kira.
First, let’s create a new project.
Next, we will be presented with this setup message where we can click on Get started
Enter the App information (this will be visible to the users from your school that connect with Kira learning, make sure you name this something trustworthy) and then click on Next. Please name it after your organization if possible. For example, if your school is Acme International High, name the project as “Acme International High for Kira.”
Make sure you mark your app as internal. This will make sure that the app is more secure and that it is available for immediate use without the need for submission for verification and audit.
Enter the contact information of the admin in charge.
Read and agree with the user data policy. And finally, click on Create.
Next, we will set up the Web Client. Go to the Clients tab in the left panel.
Click on “+ Create client” button
Pick “Web application” from the presented list
Name it something simple and identifiable
Under “Authorized JavaScript origins” click on + Add URI button and paste
https://kira-learning.comunder URIs 1, click on the Add URI button again and pastehttps://app.kira-learning.comunder URIs 2.
Under “Authorized redirect URIs” click on + Add URI button and paste https://kira-learning.com/api/auth/callback/google-classroom under URIs 1, click on the Add URI button again, and paste
https://app.kira-learning.com/api/auth/callback/google-classroomunder URIs 2.
Click on create, and you will be presented with a screen like this, with your Client ID and Client secret clearly visible. Make a note of these.
Setting up Data Access Scopes
Navigate to the Data Access tab within the left panel
Click on Add or Remove Scopes
Scroll down on the right-hand tab, paste the list given below, click on “Add to table”, and then click on “Update”.
List to be pasted:
<https://www.googleapis.com/auth/classroom.rosters.readonly> <https://www.googleapis.com/auth/userinfo.email> <https://www.googleapis.com/auth/userinfo.profile>
This completes our setting up of scopes.
Enabling Google Classroom within your project
Click on the top Search tab on the cloud console (or click on “/”)
Search for “Google Classroom API” and click on it
Click on Enable on the Google Classroom API page
Now that the Google Classroom API is enabled and the scopes are set, we are ready to onboard the workspace of your school to Kira!
Collection of the keys
Reach your customer success contact and give the following information:
Developer API Client ID.
Developer API Client secret.