Use this page to add or change API profile settings for the PLUS 360 API. These settings determine what eSchoolPlus content can be accessed on a per vendor basis. The PLUS 360 API allows approved third-party vendors access to data in PowerSchool PLUS products.
The OneRoster version 1.2 endpoints are available in eSchoolPlus version 21.4 only.
Add a new API profile
New profiles can only be created by authorized PowerSchool third parties. Contact PowerSchool Technical Support for more information.
Change or view information for an API profile
Select Administration > Utilities > Integration> API Profile to display the API Profile Search page.
If the desired configuration does not display on the Search Results panel, enter the appropriate values in the Search Criteria panel, and click Load at the top right of the page.
Click the desired configuration's Consumer Key link on the Search Results panel to display the API Profiles.
View or change information.
If you changed any information, click Save.
If you set the Authentication Method to OAuth 2.0, then the integration details required to register the vendor are shown. Copy these details and share the information with the vendor.
Change or view Advanced Settings for an API profile
Profiles that have advanced settings display (View detail) in the API Profile page's Advanced Settings field.
Select Administration > Utilities > Integration> API Profile to display the API Profile Search page.
If the desired configuration does not display on the Search Results panel, enter the appropriate values in the Search Criteria panel, and click Load at the top right of the page.
Click the desired configuration's Consumer Key link on the Search Results panel to display the API Profile Page.
Select Administration > Utilities > Integration> API Profile to display the API Profile Search page.
If the desired configuration does not display on the Search Results panel, enter the appropriate values in the Search Criteria panel, and click Load at the top right of the page.
Select the (Delete) checkbox for each record to delete.
Click Save.
Fields
Details Panel
Field
Description
Consumer Key
The public consumer key for the requester. This is the Caller ID in the PLUS 360 API for eSchoolPlus. Character/128
Consumer Secret
The consumer secret used to create the OAuth signature. Use the Show button to display or the Hide button to obscure its value. Character/128
Vendor Description
Informational text to identify the API profile. This field displays on the API Profile Search page to identify the profile. Character/128
Summer School
If selected, endpoints that are summer-school specific will only return data for summer school. If unchecked, endpoints will only return regular school year data.
Include Pre-Registered Students
Selected to also include pre-registered students for this profile. If unchecked, only registered students can be accessed by this profile.
Include Out of District
Selected to also include schools or buildings that have theirBuilding Definition Page's Out of District checkbox selected.
Include Delta Filters
Selected for any existing API Profiles. If you or your vendor are NOT using Delta Filters for this API, please deselect this for performance improvements.
New records will default to deselected and will have to be selected if you want to include them.
Active
Selected to make the profile active. All calls using an inactive profile will fail.
Log Level
The level of logging to be performed and stored in the API_Log table. The API Log table stores up to 30 days of history based on these selections:
D - Debug Mode - to use debug mode and log all transactions I - Log Most Transactions (Default) - to enable standard logging N - No Logging - to disable logging E - Only Log Errors - to only log errors
Authentication Method
Select the authentication method to use when sending messages from the API.
OAuth 1.0 (Default) - This method supports subscriptions to eSchoolPlus endpoints and OneRoster version 1 and version 1.1 endpoints. OAuth 2.0 - Use this method to grant authorization using access tokens. This method supports subscriptions to OneRoster version 1.1 and 1.2 endpoints.
When you select OAuth 2.0, the Signature Method field is set to HMAC-SHA256. The integration details that need to be shared with the vendor are shown the first time you save a profile after you select to use OAuth 2.0.
Signature Method
Select the signature method to use when sending messages from the API. HMAC is sometimes expanded as either keyed-hash message authentication code or hash-based message authentication code.
HMAC-SHA1 (Default) HMAC-SHA256 (v1.1 or later endpoints only)
Subscriptions Panel
Listing of the profile's endpoints. The Subscriptions panel displays when the Authentication Method is set to OAuth 1.0. It shows the eSchoolPlus and OneRoster version 1 and version 1.1 endpoints.
For OneRoster endpoints, nested OneRoster endpoints are included under the associated main endpoint. When you select a main endpoint on the API Profile page, the nested endpoints will be made available as well.
Scopes Panel
Listing of the profile's endpoints. The Scopes panel displays when the Authentication Method is set to OAuth 2.0. It shows the OneRoster version 1.1 and 1.2 endpoints.
JavaScript errors detected
Please note, these errors can depend on your browser setup.
If this problem persists, please contact our support.