Getting Started

Note: In order to use the ON API, your school must have the SDK installed. Talk to your Account Manager if you do not have the SDK and would like to inquire about getting it.

Step 1 - Login to the ON products as a platform manager

Go to your school's instance of the ON products [school].myschoolapp.com and sign in using your account. If you are not a Platform Manager for the school, you will need to get someone who is to sign in and perform the next step.

Step 2 - Get authorized

Now that you are signed in as a Platform Manager:

  • Go to Core —> Users/Access —> Profile —> and then “Manage Roles”
  • Click on the link for "Web Services API Manager”, select “Members” and add the user you would like to be able to access the API.

We recommend creating a user specifically for the Web Services API Manager role rather than adding to an existing user. You will be using this user's login information in Step 4.

Note: In order to see the “Web Services API Manager” Role, your school must have the SDK installed.

Step 3 - Check out the Endpoint Reference and Tutorials

Take a look at our API Reference to see what information the API allows you to access.

Read the Basics for more information on how to authenticate via the REST API, how specific errors are returned, and what the supported response formats are.

Step 4 - Try it!

Now that the proper API account is setup and you understand the how to use it to log in through the API to get your authentication token, go ahead and try to connect via your browser, or a tool designed for connecting to API’s. Click here to learn how to set this up in a free API tool called Postman.

Use the following URL to get your authentication token: https://{school}.myschoolapp.com/api/authentication/login/?username={youruser}&password={yourpassword}

Then use the following URL (or one of the other Endpoints from the reference) passing in the token retuned above using the “t=“ querystring variable. https://{school}.myschoolapp.com/api/academics/department?t={token returned from previous step}

Note: Do not include curly braces. Curly braces are used to indicate text that will be replaced with your specific version.

You should now be viewing a list of Departments in JSON Format.

Step 5 - Learn More

Read the Basics and then use the API Reference to explore more of the capabilities of the ON API. Then try more tests using this tutorial.