{"id":20364286,"url":"https://github.com/rvanasa/schoology-api","last_synced_at":"2025-08-08T04:43:47.520Z","repository":{"id":85027501,"uuid":"57913606","full_name":"rvanasa/schoology-api","owner":"rvanasa","description":"Java API implementation for Schoology (https://schoology.com) ","archived":false,"fork":false,"pushed_at":"2023-11-15T04:25:05.000Z","size":207,"stargazers_count":25,"open_issues_count":0,"forks_count":10,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-04-12T04:41:16.528Z","etag":null,"topics":["java-api","lms","oauth","schoology","schoology-api"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rvanasa.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-05-02T19:00:40.000Z","updated_at":"2024-10-04T19:08:56.000Z","dependencies_parsed_at":"2023-11-15T05:26:40.865Z","dependency_job_id":"5cd04b46-7c65-4fc6-a81f-8abb62b18ffc","html_url":"https://github.com/rvanasa/schoology-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rvanasa/schoology-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rvanasa%2Fschoology-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rvanasa%2Fschoology-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rvanasa%2Fschoology-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rvanasa%2Fschoology-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rvanasa","download_url":"https://codeload.github.com/rvanasa/schoology-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rvanasa%2Fschoology-api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269366515,"owners_count":24405239,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-08T02:00:09.200Z","response_time":72,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["java-api","lms","oauth","schoology","schoology-api"],"created_at":"2024-11-15T00:10:58.314Z","updated_at":"2025-08-08T04:43:47.477Z","avatar_url":"https://github.com/rvanasa.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# schoology-api\nJava implementation for the [Schoology API](https://developers.schoology.com/api).\n\nBehold, a straightforward two- and three-legged authentication wrapper for the Schoology REST API. \n\nMake sure to use the `schoology-impl` module for the actual OAuth ([Scribe](https://github.com/scribejava/scribejava)) implementation. \n\n## Setup:\n\nRun the following commands to install the package in your local Maven repository:\n\n```sh\n$ git clone https://github.com/rvanasa/schoology-api\n$ cd schoology-api/schoology-impl\n$ mvn clean install\n```\n\nThen, paste the following snippet into your project's POM.xml dependencies:\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003enet.rvanasa\u003c/groupId\u003e\n    \u003cartifactId\u003eschoology-impl\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n## Usage:\n\nYou can generate a user API key \u0026 secret by going to `https://[DISTRICT_PREFIX].schoology.com/api`\n\n### 2-Legged Auth:\n\n```java\n\nSchoologyRequestHandler schoology = new SchoologyRequestHandler(DISTRICT_PREFIX, API_KEY, API_SECRET);\n\n```\n\n### 3-Legged Auth:\n\n```java\n\nSchoologyFlow flow = new SchoologyFlow(DISTRICT_PREFIX, API_KEY, API_SECRET, CALLBACK_URL);\n\nSchoologyToken token = flow.createRequestToken();\n\nString authUrl = token.getAuthorizationUrl();\n\n// redirect client...\n\nString verifier = \"[Response from callback URL]\";\n\nSchoologyRequestHandler schoology = token.createRequestHandler(verifier);\n\n```\n\n### Sending a Request:\n\nRequests can be send and parsed manually, or by using the premade methods provided with the SchoologyRequestHandler.\n\n#### Manually:\n```java\n\n// [UID] represents the target user ID\nSchoologyResponseBody response = schoology.get(\"users/[UID]?extended=true\").requireSuccess().getBody();\n\nSystem.out.println(response.getRawData()); // raw JSON string\n\nSchoologyNode node = response.parse();\nSystem.out.println(node.get(\"name_display\").asString()); // get display name of user\n\nschoology.put(\"users/[UID]\", \"{\\\"name_first_preferred\\\": \\\"NewName\\\"}\"); // set preferred first name\n\n```\n\n#### Using premade methods \u0026 objects:\n```java\n\n// [UID] represents the target user ID\nSchoologyUser user = schoology.getUser(\"[UID]\");\n\nSystem.out.println(user.getNameDisplay()); // get display name of user\n\nuser.setNameFirstPreferred(\"NewName\"); // set preferred first name\n\n```\n\nBig thanks to [@electro2560](https://github.com/electro2560) for taking this project to the next level. Contributions and feature requests are always welcome! \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frvanasa%2Fschoology-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frvanasa%2Fschoology-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frvanasa%2Fschoology-api/lists"}