Skip to content

Latest commit

 

History

History
128 lines (94 loc) · 3.75 KB

README.md

File metadata and controls

128 lines (94 loc) · 3.75 KB
Raw

BETA Learnosity SDK - NodeJS

The package is currently in BETA and hasn't been fully tested for production use. Certain features found in the PHP SDK aren't fully supported.

Include this package into your own codebase to ease integration with any of the Learnosity APIs.

Installation

NPM

npm install [--save|--save-dev] https://github.com/Learnosity/learnosity-sdk-nodejs

To install from a tag:

npm install [--save|--save-dev] https://github.com/Learnosity/[email protected]

git clone

git clone [email protected]:Learnosity/learnosity-sdk-nodejs.git

If you don't have an SSH key loaded into github you can clone via HTTPS (not recommended)

git clone https://github.com/Learnosity/learnosity-sdk-nodejs.git

Examples

You can find a complete site with examples of Learnosity APIs integration in our demos site.

You can download the entire site or browse the code directly on github.

Usage

Learnosity.init()

The init function is used to create the necessary security and request details used to integrate with a Learnosity API. Most often this will be a JavaScript object.

The init function takes up to 5 arguments:

  • [string] service type
  • [array] security details (no secret)
  • [string] secret
  • [request] request details (optional)
  • [string] action (optional)
var Learnosity = require('learnosity-sdk-nodejs');

// Instantiate the SDK Init class with your security and request data:
var request = Learnosity.init(
   'questions',
   {
       'consumer_key': 'yis0TYCu7U9V4o7M',
       'domain':       'localhost',
       'user_id':      'demo_student'
   },
   'superfragilisticexpialidocious',
   {
       'type':       'local_practice',
       'state':      'initial',
       'questions':  [
           {
               'response_id':         '60005',
               'type':                'association',
               'stimulus':            'Match the cities to the parent nation.',
               'stimulus_list':       ['London', 'Dublin', 'Paris', 'Sydney'],
               'possible_responses':  ['Australia', 'France', 'Ireland', 'England'],
               'validation': {
                   'valid_responses': {
                       ['England'], ['Ireland'], ['France'], ['Australia']
                   }
               }
           }
       ]
   }
);
// Pass the object to the initialisation of any Learnosity API, in this example the Questions API
<script src="//questions.learnosity.com"></script>
<script>
    var questionsApp = LearnosityApp.init( {{ JSON.encode(request) }} );
</script>

Init() Arguments

service
A string representing the Learnosity service (API) you want to integrate with. Valid options are:

  • assess
  • author
  • data
  • events
  • items
  • questions
  • reports

security
An array^ that includes your consumer_key but does not include your secret. The SDK sets defaults for you, but valid options are:

  • consumer_key
  • domain (optional - defaults to localhost)
  • timestamp (optional - the SDK will generate this for you)
  • user_id (optional - not necessary for all APIs)

^Note – the SDK accepts a JSON string and native javascript objects.

secret
Your private key, as provided by Learnosity.

request
An optional associative array^ of data relevant to the API being used. This will be any data minus the security details that you would normally use to initialise an API.

^Note – the SDK accepts a JSON string and normal Javascript objects.

action
An optional string used only if integrating with the Data API. Valid options are:

  • get
  • set
  • update
  • delete