Ed-Fi-Exchange-OSS / LMS-Toolkit

Tools for accessing and analyzing instructional system data

https://techdocs.ed-fi.org/display/EDFITOOLS/LMS+Toolkit

Apache License 2.0

11 stars 12 forks source link

Schoology API Sandbox setup #391

Closed stephenfuqua closed 4 months ago

stephenfuqua commented 4 months ago

Jira Description

Story

As a Fizz developer, I want to be able to access a sandbox of Schoology to get access to key data points.

Acceptance Criteria

API responding and sending data
Export function working - [https://support.schoology.com/hc/en-us/articles/201000973-Export-Enterprise-]

Jira Metadata

Key: LMS-6 Epic: n/a Created: 2020-08-13T11:08:50.000-0500 Reporter: Eric Jansson

stephenfuqua commented 4 months ago

Jira Comment

The Schoology instance I am able to access is located at [https://app.schoology.com/login]. I went through submitting a request via [https://app.schoology.com/apps/developer/request]. It took nearly a week to get a response and get approval. I did create an api consumer key and an api consumer secret. It seems that there is only the ability to have one in this environment. Ping Eric for the environment credentials and api key information

Jira Metadata

Created: 2020-08-24T16:13:10.723-0500 Commenter: Cy Jones

stephenfuqua commented 4 months ago

Jira Comment

Thanks [~cyjones]. I made a developer request and it was approved the same day. They seem to give you access to an administrator account on a sandbox system.

[~Stephen.Fuqua] I created an administrator account for you on my instance - you should have gotten an email with your login info. Same URL as above for Cy. If you would, go in and click to see if you have admin permissions:

Tools > School Management > Integration > API

You should see the API key there.

If this works, I'll make an account for all team members.

Jira Metadata

Created: 2020-08-25T09:25:25.343-0500 Commenter: Eric Jansson

stephenfuqua commented 4 months ago

Jira Comment

Also, note that for Schoology we should look at the "Exports" option before deciding to go with API access. Exports may give us what we want.

Jira Metadata

Created: 2020-08-25T09:26:15.753-0500 Commenter: Eric Jansson

stephenfuqua commented 4 months ago

Jira Comment

I'm in! Thank you.

Jira Metadata

Created: 2020-08-25T09:32:12.043-0500 Commenter: Stephen Fuqua

stephenfuqua commented 4 months ago

Jira Comment

I have successfully established an exploratory API integration, querying for all courses and all users. Code is in the repository under {{examples/schoology/explore.ipynb}}.

The export functionality does work. It takes several clicks to get a file. If you customize the included columns or provide any filters, then you need to re-apply those every time you do a manual export. There is an automated export facility that requires an SFTP server. As I do not have an SFTP server available, I did not test out this functionality.

Jira Metadata

Created: 2020-08-28T10:45:03.083-0500 Commenter: Stephen Fuqua

stephenfuqua commented 4 months ago

Jira Comment

Thanks [~Stephen.Fuqua] I'd suggest we just pursue API-based extraction for now, given possible complexities of SFTP setup and the config options you mention.

Jira Metadata

Created: 2020-08-28T11:58:12.293-0500 Commenter: Eric Jansson