Experience API (Tin Can API) Library
A PHP library for implementing the Experience API (Tin Can API).
For hosted API documentation, basic usage instructions, supported version listing, etc. visit the main project website at:
For more information about the Experience API visit:
Requires PHP 5.5 or later. (If you must run something older you should look at the 0.x release series or the PHP_5_2 branch.)
TinCanPHP is available via Composer.
php composer.phar require rusticisoftware/tincan:@stable
When not using Composer, require the autoloader:
Tests are implemented using the latest stable version of PHPUnit. It will be installed when using Composer. Configure the LRS endpoint and credentials by copying the
tests/config/config.php then setting the values for your LRS.
Once configured run:
Documentation can be output using phpDocumentor2. It will be installed when using Composer. To generate documentation:
From the root of the repository after running
php composer.phar update. Documentation will be output to
If you do not have the default timezone set in your
php.ini file you can create one in the base of the repo and use the
PHPRC environment variable to point to it. Use something like:
And set the timezone in that file using:
[PHP] date.timezone = "US/Central"
These instructions are for creating the requisite public/private key pair and certificate on a Mac with OpenSSL installed. See https://www.openssl.org/docs/HOWTO/certificates.txt and https://www.openssl.org/docs/HOWTO/keys.txt.
Generate a private key (which contains a public key) without a password (not recommended):
openssl genrsa -out privkey.pem 2048
To generate a private key with a password:
openssl genrsa -des3 -out privkey.pem 2048
Create a certificate signing request:
openssl req -new -key privkey.pem -out cert.csr
To create a self signed certificate (as opposed to one signed by a CA), primarily for testing purposes:
openssl req -new -x509 -key privkey.pem -out cacert.pem -days 1095