Connect to API

[dhust]

Hi. What steps do local administrators of PS in a district need to do to setup API access? I've talked with someone in my district but they don't seem like they know. Thank you.

[BlayneC]

What kind of API access are you looking for?
Is this a 3rd party app?  If so, it may have a plugin that can be loaded in PowerSchool that will then provide API access after obtaining a ClientID and Secret.
If you are looking to develop your own software that uses an API to get data from PowerSchool, then you will need to create your own plugin (usually a simple xml file to start with).

[dhust]

• Looking to grab student classes, grades, and similar info.
• This is not a 3rd party app.
• I'll be developing the app
  • I'm pretty sure I would need more than an XML file. I think I need an API key and such. 
  • Also looking for API endpoints to connect to. Not sure where that info is.

[mbezaire]

You want to navigate to your district's schoology link with "/api" tacked on to find your api key and secret.  Ex:  mydistrictlms.schoology.com/api

Then, look at https://developers.schoology.com/api-documentation/rest-api-v1/ for endpoints

[dhust]

I'm not using Schoology. I just want to create something myself using PS's API.

[BlayneC]

I replied down below in this discussion. Wanted you to know you have a reply to your post that you want to build something yourself using APIs from PowerSchool.

[mbezaire]

For PowerSchool generally I think you would need to work with a PowerSchool contact within your district to get access to PowerSource and then log into there and visit https://support.powerschool.com/developer

[BlayneC]

When getting the Bearer Token using Postman, select "Basic Auth" in the Authorization tab - this gives you the "Username" and "Password" fields that you fill in with the Client ID and Client Secret from your plugin.

Forgot to mention that in my reply above.

[eltontipa]

Setting up API access in PowerSchool typically involves a few steps, and local administrators in a district may need to follow specific procedures. Please note that the exact steps can vary based on the version of PowerSchool you are using and the specific configuration of your district's PowerSchool instance. Here's a general guide:

1. Contact PowerSchool Support: The first step is to reach out to PowerSchool Support or your designated support contacts within your school district. They can provide guidance on the specific process for setting up API access and any prerequisites or permissions that may be required.

2. Request API Access Credentials: PowerSchool API access is often controlled through API credentials, including an API key and potentially other authentication details. You may need to request these credentials from PowerSchool Support or your district's PowerSchool administrators.

3. Verify Permissions: Ensure that your user account has the necessary permissions to access the PowerSchool API. PowerSchool typically allows administrators to define roles and permissions for users, so you may need appropriate access rights to work with the API.

4. Review PowerSchool API Documentation: Familiarize yourself with the PowerSchool API documentation. The documentation provides details on available API endpoints, data formats, authentication methods, and usage guidelines. This information is crucial for integrating PowerSchool data into your applications.

5. Test API Connectivity: Before implementing any production-level integrations, it's a good practice to test API connectivity. You can use tools like cURL or Postman to make test API requests and ensure that you can successfully retrieve or update data.

6. Implement API Integration: Once you have the necessary credentials and have tested API connectivity, you can proceed with implementing the API integration into your applications or systems. This may involve making HTTP requests to PowerSchool API endpoints based on your specific use case.

[peteryee82]

Is there a separate documentation for Native Powerschool APIs vs Powerschool OneRoster APIs?  I can't seem to find them.  Does anybody have some example Powerschool OneRoster endpoints?  

[DanielS8]

Same... OneRoster API is a mystery to me at this point and Instructure is telling me to change endpoints there...