API Resources Guide

Schoox is an all-in-one learning and development platform. We have everything you need to train your teams, measure results, and develop the skills people need to pursue opportunities. We provide intuitive experiences that amplify learning and development for everyone and watch your learners thrive.

Overview

Product development engineers at Schoox recognized from day one that the leading Talent Development Platform could not operate in a vacuum. Instead, we understood that the innovative features of Schoox could be amplified if the software interoperated with the other mission-critical technologies that power modern business. To that end, we committed early to the principle of integration as a core competency.

Interoperability with external systems was a core consideration in Schoox’s technical architecture, and we remain committed to offering the most flexible and powerful integration options of any talent development solution. We achieve this goal via:

• Support for integration standards
• An open, standards-based RESTful JSON API, which is free to use for all customers. Documentation is available at https://app.schoox.com/api-docs
• Integration modules, tools, training and support

This document describes the resources that you will need in order to leverage user provisioning and synchronization, learner data exchange, and other integration processes via API.

User Provisioning and Synchronization

You can create users in Schoox manually or leverage FTP to sync user data through a daily feed. However, many organizations prefer a more dynamic approach—keeping their data up to date in real time by connecting Schoox with external systems like an HRIS, payroll, or scheduling platform.

The methods outlined below give you the flexibility to sync user profile information, roles, jobs, and organizational details (such as location or department) via API, at a frequency that fits your needs.

• Schoox’s RESTful JSON API. For more complex user synchronization workflows, or if your internal IT staff has the skill and capacity, users can be created programmatically and securely via our open API. All aspects of user administration are exposed via our API. It is battle-tested, handling heavy use by extremely large organizations, and remains a development priority.
• Direct connections to external APIs. If your HRIS or other external system offers an API, Schoox can probably connect directly to that API to import and synchronize users. If it is a system we’ve integrated previously, like UltiPro or HotSchedules, the connection may be a simple configuration. If not, we have software modules for connecting to most kinds of standard APIs, including JSON and SOAP. Please be advised that direct connections facilitated by Schoox will require an additional scope of work. Contact your Implementation Manager, Client Success Manager, or Support for more details.

Learner Data Exchange

Schoox offers extensive and comprehensive reporting. When it comes to learning and training data, our customers find our product’s internal reporting tools to be far superior to the external systems with which we integrate. Even so, there is great value to having that training, proficiency and certification data to amplify the power of your HRIS, scheduling, or other mission-critical platform. We offer flexible tools for enabling this data exchange via API:

• Schoox’s RESTful JSON API. Almost all user data is available for programmatic access via our open API (If it isn’t available, it is probably because nobody has asked us for it yet; we’re eager to add any available data to our API). Using this mechanism, you can easily extract data from Schoox and transfer it to any other system you use.
• Direct connections to external APIs. If your HRIS or other external system offers an API, Schoox can probably connect directly to that API to push learner data directly into your system. We have existing connections with several providers, and we also have software modules for most kinds of standard APIs, including JSON and SOAP. Please be advised that direct connections facilitated by Schoox will require additional scope of work. Contact your Implementation Manager, Client Success Manager, or Support for more details.

Getting Started

If you opt to work with our RESTful JSON API, you’ll require the following to get started:
Schoox Open API Docs – this can be found at https://app.schoox.com/api-docs and includes calls, responses and notes.
Academy ID – this can be found in the URL for your academy, or on the API Key page.
API Key – This can be accessed via the API Key page. To locate this page, please follow the steps outlined below.

In the left navigation, make sure you are in the Academy Workspace.

When in the Academy Workspace, select Academy Admin for all Academy Administration options. 

Select Configuration and then General.