Client Libraries

Our client libraries are an easy way to integrate with the SCORM Cloud API. With the client libraries, you can forget about all the nuances of making web requests: headers, request methods, and “Was that parameter supposed to be in the body or the query parameters?” The client libraries allow you to make requests to our API like you would any other library, by simply passing parameters to a method/function. All of the web interface is handled for you.

We offer a number of common language libraries, which are all published to the relevant package managers, as a convenience to get started quickly with our API:

• Java
• C# (.NET)
• PHP
• Python
• Ruby
• JavaScript

Don’t see a language you’re in love with above? Check out the swagger-codegen project to see if there is out of the box support for one that you do!

Included within the README of each client library is a segment of sample code that will run through the basic workflow behind many of the integrations with SCORM Cloud: importing a course, creating a registration, launching the registration, and collecting data about said registration. We’ve also included samples for getting information about all the courses and registrations stored in SCORM Cloud. And at the end, we show how to delete a course / registration, which also has the added benefit of cleaning up all the sample data once you’re done.

We highly recommend using a client library as they will make integrating with SCORM Cloud much easier.

Additional Details

Our REST API is built in conformance with the OpenAPI Specification. As such, we have a publicly available API specification here. It can be seen at any point in time as the source of truth of semantics of the API, and is the document from which our client libraries are programmatically generated.

Since our client libraries are programmatically generated, you’ll also notice that in the API Method Reference that each service has a directory of endpoints which will match exactly with the method names in each of the client libraries.

Note: Because our client library repositories are programmatically generated, we can’t accept any pull requests to them. Any changes must be made to the underlying templates which dictate the generation process. Feel free to raise issues on the repositories, however, if you find a problem.

From here, you can jump off to any of the following:
- Dive into one of our tutorials
- Read more about our V2 API in the reference section: API Overview
- Dive straight in with the API Method Reference