API FAQs

Which parents/guardians will pull for the LMS API?

Parents/guardians associated with at least one student that is set as current year active and/or next year active.

LMS API URL

This is the base API URL can be provided to vendors who wish to connect to Skyward through the LMS API.

AppServer

This is your Student Management/School Management AppServer along with the UDP port being used to connect to your NameServer. The AppServer is a back-end broker that processes data for the API. The AppServer fields are read only and displayed for informational purposes.

. Can a school with standards-based grading use passback?

a. Scores can be passed back for those using standards-based grading. b. If this is the case, the academic area for Standards Gradebooks that plan to use the API needs to be set to manually enter grades. This is set in WS\EA\GB\ST\AA - Grade Calc Option Maintenance. It is not recommended they be changed to manual during the school year, as data in the gradebooks will be lost.

Can a field be added to the API for our district?

a. Since API is programmatically consistent for all districts, we are not able to add or alter the available fields for an individual district's API. b. Changes to the overall API would potentially impact existing integrations for all districts using it and the parties with whom they share data. c. If there is a change you would like to see, such as the addition of a field, you are welcome to submit a Product Idea for future consideration.

Where do teachers enter their grades then?

a. Teachers will work exclusively in either the gradebook in the third-party program or the Skyward gradebook. They must choose one or the other and be consistent. b. Assignments and assignment scores entered in a third-party program will be sent to Skyward and will overwrite any records in the class's Skyward gradebook. If scores are entered in Skyward, they will be overwritten by the synced data from the third party.

Is there an additional cost to use API?

a. If you would like to send information from Skyward to third parties, there is no additional license required. This is called the Read Only API. b. If you are interested in sending assignment scores from a third party back to Skyward, you will need to acquire a license. This will allow teachers to use gradebooks within a different program and have the scores sent directly to Skyward, saving them time and ensuring accuracy. c. If you are interested in acquiring this license, reach out to your district's sales representative.

How can I see what information has been synced from a third party to Skyward?

a. In PS\CA\DS\CF\AP there is an LMS/OneRoster API Log you can use to see what assignments and assignment scores have been updated in Skyward and locate errors if they are occurring. b. When teachers look at assignment details within their Skyward gradebook, they will be able to see when changes to scores were made for their students and the name of the secured user associated with the API connection. c. Teachers will also have an API Log within each individual gradebook that has synced grades under the Display Options tab. This will have a record of every update made in the gradebook via API.

What should I name the secured user?

a. It is best practice to name the secured user after the company that you are connecting with. b. If you are using API to pass back assignment scores to Skyward, this is the name that will display in API logs as having made updates.

What are the different versions of the API?

a. LMS API: This is an API that was designed by Skyward. It was built with our databases and fields in mind, so it offers a lot of Skyward-specific fields from throughout our student software. b. OneRoster API: OneRoster is a standardized way to format student data. Many educational software companies recognize and accept this format, so even if they do not officially partner with Skyward, it is possible that we can still share data.

Where can I go to test my API to make sure it is working?

a. Locate Product Setup > Skyward Contact Access > District Setup > Configuration > API Configuration. b. Click the Swagger Test URL to bring up your Swagger page.

What Skyward ID is used to identify a student/guardian/staff member/school/ course/class in the OneRoster API?

a. Most of these use the same ID numbers listed above for the LMS API. The main difference is that all ID numbers in OneRoster will have a prefix. You must know how to construct an ID to search for it on Swagger. i. Student: USRstudent + Internal ID (ex: USRstudent1776) ii. Guardian: USRguardian + Name ID (ex: USRguardian1767) iii. Teacher: USRteacher + Name ID/Staff ID (ex: USRteacher32) iv. School: ENT + Entity Number (ex: ENT400) v. Course: CRS + Course ID (ex: CRS112) vi. Class: CLS + Class ID (ex: CLS402) OneRoster does not use the same Class ID as the LMS API above. To find the Class ID, go to the class's gradebook, click the class information at the top of the screen, then in the popup window doubleclick the class name again. You can also data mine and use Skybuild to export this number.

Which teachers and students will pull to the LMS API?

a. Students: i. The LMS API will only return active students when looking in Students > Get Students for a School. This is how most third parties determine which students are currently active. ii. The Students endpoint will return the student's active schools in the "SchoolIds" array. If the array is empty, they are not active in the current year in any schools. b. Staff: i. Within StaffMembers > Get Staff Members for a School, only active staff will be returned for the specified school. The "TeacherSchoolIds" array will contain the schools where the staff member is teaching at least one class. ii. StaffMemberSchool will contain schools where the staff member is active in the current year -OR- teaching at least one class. iii. Staff are identified as teachers, discipline officers, counselors, and substitutes with the checkboxes on the staff record. Each of these fields pulls as a separate value.

Which teachers and students will pull to the OneRoster API?

a. Students: i. The OneRoster API will only return active students when looking in Students and searching by School ID. ii. All Student OneRoster API Endpoints will only return students if they have at least one active entity. b. Staff: i. Teachers need to be active in the current year, flagged as a teacher and teaching an active class to pull. This is the same as with the OneRoster export in SkyBuild.

What is Swagger?

a. Swagger is the name of a site that will let you test the data that is available on your API. It is often used in troubleshooting to see the specific information coming from Skyward and being consumed by the third party. b. To be able to see the data on this site, you will need to enter valid credentials. For API, these credentials are called a key (username) and secret (password).

My vendor says that they are not able to get any data from our API. What do I do?

a. The first step is to confirm that they have the correct credentials (key/secret). i. Locate the secured user in Skyward that is associated with that vendor and click the API button. ii. Try logging into your Swagger test page with that key and secret to see if they work. If you enter them, click Get Token, and see text fill in in the field, that means that they should be working. iii. Make sure that this is the key and secret that the vendor has on file. iv. If that key and secret are not valid, you can choose to generate a new secret for the secured user. Just make sure that if you do this you share the new secret with the vendor. b. Make sure that the vendor has the correct URL. This can be found in the API Configuration screen in PS\CA\DS\CF\AP. They should be able to tell you if they are using the LMS API or OneRoster API. c. If you are using API with other vendors, confirm that they are still able to retrieve data from your API. i. This can help determine if it's an overall issue or if it's specific to this one vendor.

How can I locate information for a student on the OneRoster API?

a. Within Skyward, locate the internal ID for the student you would like to test. (instructions to locate this are in question 19 above) b. Log into Swagger and select the third option from the dropdown menu to test the OneRoster API. c. Next, choose the appropriate endpoint (Students in this case). Expand the endpoint and select how you would like to search. I chose to get a student based on their ID. d. Enter USRstudent + the student's ID and click Try it out! Keep in mind that depending on the endpoint you are searching, different criteria are required and will be noted as such. e. The text in the Response Body is what is pulling for that particular student for the endpoint. This will match what is in Skyward and is what is available to your third parties.

How can I locate information for a student on the LMS API?

a. Within Skyward, locate the internal ID for the student you would like to test. (the following question explains where this is located) b. Log into Swagger and select the first option from the dropdown menu to test the LMS API. c. Next, choose the appropriate endpoint (Students in this case). Expand the endpoint and select how you would like to search. I chose to get a student based on their unique ID. d. Enter the student's ID and click Try it out! Keep in mind that depending on the endpoint you are searching, different criteria are required and will be noted as such. e. The text in the Response Body is what is pulling for that particular student for the endpoint. This will match what is in Skyward and is what is available to your third parties.

How do I log into my Swagger page to see our data?

a. You will need a Key (username) and Secret (password) to get a Token (log in). b. It is best practice to have a secured user set up for each third party accessing your API. You can use the key and secret for one of them to log in and test what data is pulling and confirm that their credentials work. Locate the third party in the Secured Users area and click the API button to view/use their credentials. Enter this on Swagger and click Get Token. c. Once text appears in the field to the right of Get Token, you are logged in and able to access data.

Can I choose which data is available to a third party?

a. There is no way to select which fields are shared via API; it is all or nothing. Once the third party has valid API credentials (key/secret), they can access any information they like on the API. Different parties consume different data depending on what they need for their software. b. It is up to the third party to determine which data they will consume and what to do with that information once it is in their program. There are no filters within Skyward to limit or range for certain information.

What kinds of information can be sent back to Skyward from other programs?

a. With the license, you can pass back assignments and assignment scores to Skyward to make updates in teacher gradebooks. b. Grades will still be calculated within the Skyward gradebook based on Skyward configurations.

What is API?

API (application programming interface) is a way for data to be shared between parties. In this context, it means that you can share data between Skyward and different third-party vendors. This can aid in accuracy and consistency of data while reducing data entry time.

LMS/OneRoster API Configuration: Automatically Restore Valid Deleted Assignments When Edited

If teachers go into the EA+ Gradebook and delete assignments, these assignments are not deleted in the thirdparty vendor system. Before the API could allow edits again, the teachers would have to restore the deleted assignment. With this option ON, as long as the assignment is not in a closed and locked grading period, the API will automatically restore the assignment when an update is posted through the API.

My API is set up, now how do I connect with a vendor?

You will need the appropriate url, key and secret to share with the third party.

A staff member is not appearing in our third-party program. What should I check to get them to pull correctly?

a. Are they flagged as a teacher? b. Do they have a default entity? c. Do they teach a current year class? i. If your librarians or other non-teaching staff members need access in your third-party program, consider adding them to a current year class as a teacher. It even could be a course/class created solely for this purpose. d. Are they a secured user? i. Make sure that the staff member is an active secured user in Product Setup.

How do I see if API is set up for my database?

a. Navigate to Product Setup > Skyward Contact Access > District Setup > Configuration > API Configuration. If the fields are empty (like below) you do not have API set up. If there is URL information, you are set up to share data with third parties. If you see an API Log, you are set up to pass back assignment grades.

How does Skyward know where to put the synced assignment scores?

. Skyward looks in the specific class's gradebook for an assignment with the same description, due date, and category to determine a match. If those fields all align, scores will be synced.

Can I use the same key and secret for all the vendors connecting via API?

We recommend creating a separate secured user for every vendor you connect with. i. This way you can change a key/secret for one vendor without having to inform every other vendor of the change. ii. You are better able to troubleshoot why vendors are having issues if each vendor has a separate set of credentials. iii. If using pass back, you can differentiate between the different parties that are syncing grades to Skyward.

What Skyward ID is used to identify a student/guardian/staff member/course/class in the LMS API?

a. Student: Internal ID i. Double click the student's name in the student profile. ii. Or go to the student information page. b. Guardian: Name ID. Edit the guardian record and check the URL to see their ID number. c. Staff Member: Name ID/Staff ID. i. Go to the picture tab on their staff record. (Number after "NS") ii. Or scroll all the way to the right on the Staff Browse and look under Name ID. d. Course: Course ID is visible on the Course Master in the Course Details area. e. Class: For the LMS API, the Class ID this is not something you look up within Skyward. You can figure out the Class ID if you know the Course ID and the section number. i. Class ID = Course ID + .0. + Section Number ii. Ex: Course 8945, section 03 would be 8945.0.03

How do I get API for my district?

A. Read-Only API (data leaving Skyward) i. If you are state-hosted, hosted by ISCorp, or Managed Services, your hosting provider will be able to set this up for you. Please contact us by creating an IT Services service call using Support Center. ii. If you are self-hosted, you can use our Launch Kit to set this up on your server. iii. If you would like Skyward to set this up, it would be billable. Let us know if you would like to go this route by creating an IT Services service call using Support Center. B. Passback API (data coming into Skyward) i. A license is required for the passback of assignments and assignment scores. Please contact your sales representative for more information.

LMS/OneRoster API Configuration: Allow Combined Gradebook Assignments to Post Once for Each Section

Generally we recommend against allowing Combined Gradebooks when using the API because there really is no benefit when not using the EA+ Gradebook. Even if combined gradebooks are allowed in Skyward, they are not really combined on the third party's end. If there were three classes combined, for example, the vendor would post an Add for each of the three assignments. With this option turned OFF only the first assignment will return with a success. With this option turned ON, all three assignments will return a success and return the same assignment ID because on our end they are the same assignment. Note: Skyward considers the same assignment date and title when considering combined/duplicate assignments.

Can we connect with more than one third party with the same passback license?

Once your district has purchased the license to use the passback API, you are able to use that with any combination of third parties you choose. You do not need to purchase a separate license for each third party.

LMS/OneRoster API Log

Skyward keeps a log of data that is passed into the API by a third-party vendor. Skyward does not log which data is consumed by a third-party vendor. The API Log is limited to gradebook assignment data, assignment scores, standards grades, and OneRoster Line Item data. The API Log offers a browse screen to view this data. There is also an API Log specific to a given teacher's gradebook available in the EA+ gradebook under Display Options > API Log.

OneRoster API URL

This API URL includes the OneRoster suffix and can be provided to vendors who wish to connect to Skyward through the OneRoster API.

Authentication URL

This URL can be provided to vendors who request it for use with token-based authentication.

Swagger Test URL

This is a link to the Swagger test page which can be used to test what data is actively available through the API. There is a dropdown to select the LMS API as well as the OneRoster API. The available data endpoints will depend on this selection. The following link includes helpful information on how to use Swagger for testing. A key and secret are required to make use of Swagger. You can locate/generate a vendor's key and secret by navigating to Product Setup > Skyward Contact Access > Security > Users > Secured, selecting the Secured User for the vendor, and clicking on the API button.

OneRoster API Line Item Configuration Default Category

This option should be used when a third-party vendor does not require Categories in the OneRoster Line Item Endpoints. It is highly recommended that you add this Default Category to all Category Groups whose Gradebook Assignments are posted through the OneRoster API. If the Default Category is not valid for a Class: • The Assignment will show in red in the EA+ Gradebook. • The teacher will have to manually save each Assignment with a valid Category in the EA+ Gradebook. • The Assignment will not count towards a Grade when Categories are weighted.

I already export data to third parties through SkyBuild. What is the difference?

a. API allows for real-time sharing of data. Third parties will be able to access the most up-to-date information rather than only getting updates once a day with a scheduled task. b. Once an integration is established, there is rarely maintenance needed for these connections. There is no updating of export file layouts or ranges. c. The fields available in SkyBuild differ from those in API.

When are assignment scores synced back to Skyward?

a. Assignment scores will be synced if the assignment is associated with an active grading period or falls within the grade input window for the grading period. b. After the grade input window is closed for the respective grading period, assignment scores would need to be updated manually in Skyward as they will no longer be synced from the third-party gradebook. c. If you are auto-posting grades in Skyward, ensure that the final auto-post takes place after scores are done syncing to Skyward for the grading period. This way the posted grades might not reflect the most recently synced assignment scores.