logan-reynolds / moodle-local_akindi Goto Github PK

Synchronize course rosters and grades between Akindi and Moodle (2.7+, 3.0+).

1. Generate an Akindi API key:

1. Login to Akindi, then click LMS Integrations under the "Administration" heading on the left nav bar (if you don't see the LMS Integrations options, please contact akindi so we can give your account access to LMS integration options).
2. Click "Add LMS Integration" and fill out the form. Make sure that the LMS URL field beings with https:// and contains the complete path to the location Akindi's local plugin will be installed. The URL is usually similar to https://moodle.yourschool.com/moodle/local/akindi.
3. Make note of the "Public Key" and "Secret Key"; you'll need these in step 8.

2. Download the latest version of the plugin from Github: https://github.com/akindi/moodle-local_akindi/archive/master.zip
3. Login to your Moodle instance, and under the Administration panel, expand Plugins and click Install plugins:

4. Under the Install plugin from ZIP file heading, click the Choose a file… button:

5. Click Choose File, select the zip file downloaded in step 2, then click Upload this file:

6. Once the zip file has been uploaded it should appear in the file list below the Install plugin from ZIP file heading. Click the Install plugin from the ZIP file button:

7. Once the plugin has been validated, click Continue:

8. Under the Administration panel, expand Plugins, then Local plugins, and click Akindi Settings. Fill in the values appropriate to your installation:

   akindi_launch_url

   Testing: https://dev.akindi.com/api/moodle/launch

   Production: https://akindi.com/api/moodle/launch

   akindi_public_key

   The public key from step 1 (it will start with pk_).

   akindi_secret_key

   The secret key from step 1 (it will start with sk_).

   akindi_instance_secret

   A secret key you have generated which should not be shared with Akindi. The default value is generated randomly on each page load and is a suitable default.

   This key is used to sign tokens sent to Akindi and should not be changed after the initial application setup.

9. Test your integration: navigate to a course, expand Course administration, then click Launch Akindi!

Akindi assumes that student's idnumber field will be a numeric student ID. Akindi will still function if it isn't, but the instructor will have to manually assign each scanned sheet to a student.