-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
5182ae1
commit ec37591
Showing
1 changed file
with
19 additions
and
92 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,95 +1,22 @@ | ||
| # NIM-System-REST-Skyward-OneRoster-v1.2 | ||
| Skyward OneRoster v1.2 | ||
| # Skyward OneRoster v1.2 | ||
| <img src="https://www.tools4ever.nl/connector-logos/skywardqmlativ-logo.png" width="256px" /> | ||
|
|
||
| ## Data Tables | ||
| - Academic Sessions | ||
| - Categories | ||
| - Classes | ||
| - Courses | ||
| - Demographics | ||
| - Enrollments | ||
| - Line Items | ||
| - Orgs | ||
| - Resources | ||
| - Results | ||
| - Score Scales | ||
| - Users | ||
|
|
||
| ## Actions | ||
| N/A | ||
|
|
||
| <p align="center"> | ||
| <img src="https://www.tools4ever.nl/connector-logos/skywardqmlativ-logo.png"> | ||
| </p> | ||
|
|
||
| ## Table of Contents | ||
| - [Setting up the API Access](#setting-up-the-api-access) | ||
| - [General Notes](#general-notes) | ||
| - [API User](#api-user) | ||
| - [API User Access](#api-user-access) | ||
| - [Integration Access Secrets](#integration-access-secrets) | ||
| - [Configure NIM](#configure-nim) | ||
| - [NIM docs](#nim-docs) | ||
|
|
||
|
|
||
| ## Setting up the API Access | ||
| ### General Notes | ||
| Each API Vendor should have an Integration record available in Qmlativ. | ||
|
|
||
|  | ||
|
|
||
| The APIs used by an Integration can also be viewed from the Integration List screen by looking at the lower browse. The APIs may also be viewed from the Integration APIs tab on the Integration Details screen. | ||
|
|
||
|  | ||
|
|
||
| If the vendor has indicated that they are using the Custom API, select it to see which Objects and Fields are being used, and what types of access they have to them. | ||
|
|
||
|  | ||
|
|
||
| An Integration Access record is required to grant Qmlativ API access, similar to the API User record. | ||
| If the vendor has requested to set up new Integration Access credentials and their Integration is not visible in the Integration List, please reach out to Skyward to ensure that the Integration Sync process is working properly. | ||
|
|
||
| ### API User | ||
| A new Integration Access record should exist for each active API User record. | ||
| API User records may be found under the API area by selecting the User feature: | ||
|
|
||
|  | ||
|
|
||
| You may find/create Integration Access records by going to the API area and select the Integration Access feature: | ||
|
|
||
|  | ||
|
|
||
| Integration Access records can also be found/created from the Integration Details screen. | ||
|
|
||
|  | ||
|
|
||
| It is recommended to copy most of the API User’s settings into the Integration Access. | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| The areas highlighted in red (1-4) can be taken from the API User record. The area highlighted in blue (5) can be taken from the API User Access records associated with the API User record. These values can also be changed to something new but keeping them the same reduces the possibility of errors during the initial conversion. | ||
|
|
||
| **NOTE**: _OAuth1 as an Authentication Type has been removed for the Integration Access system. Each vendor that used OAuth1 should migrate to OAuth2 for the new Integration Access system._ | ||
|
|
||
| ### API User Access | ||
|
|
||
| One of the main benefits of the Integration Access system is that each Integration is already pre-packaged with which APIs it uses, and therefore with which configuration records it is associated. When configuring an Integration Access, selecting the vendor’s Integration will automatically display the expected API Configuration sections. | ||
| Here is an example of the Integration Access screen when the selected Integration uses all APIs. As you can see, the Configuration section displays all configuration options for the APIs: | ||
|
|
||
|  | ||
|
|
||
| **NOTE:** _OneRoster, Time Tracking, Identification, Attendance, and Enrollment Configuration records can be shared between the API User Access and Integration Access records._ | ||
|
|
||
| Custom API Entities is a new entity selector that controls which entities the vendor has access to. For Integrations that use the Custom API, the modules, objects, and fields that are used by the Integration are now visible on the “Integration Objects” tab, so the old “Allow Security Module Write Operations” checkbox that was on the API User Access is now obsolete. | ||
|
|
||
| ### Integration Access Secrets | ||
| Secrets work differently in the Integration Access system than they did in the API User system. In all situations, it is not possible for districts to generate their own complete set of API credentials. | ||
|
|
||
| * For vendors who do not enable the district to create their own Secret, only a Key and Secret is required to authenticate themselves in the Qmlativ API. | ||
| * For vendors who enable the district to create their own Secret, there is a hidden third value stored by the vendor that enables the Integration Access connection. | ||
|
|
||
| Secrets generated for Integration Access can only be viewed once; they cannot be retrieved after closing the confirmation dialog. | ||
|
|
||
|
|
||
| # Configure NIM | ||
| 1. Edit the System to configure the connection information | ||
|
|
||
| 2. Enter the necessary information for the system | ||
| - Customer/tenant ID | ||
| - This is the URL to the instance, typically in this format | ||
| -<Customer>.skyward.com/<customer>API | ||
| - Client ID | ||
| - Enter the Client Key from the Skyward integration Access Screen | ||
| - Client Key | ||
| - Enter the Client Secret from the Skyward Integration Access Screen | ||
| - Integration Key | ||
| - Please reach out to Tools4ever support (support@tools4ever.com) to obtain this key. This key is generated on a per customer basis for access to use the integration | ||
|
|
||
| # NIM Docs | ||
| The official NIM documentation can be found at: https://docs.nimsuite.com | ||
|
|