API: Launch Link

Retrieves a one-time URL to launch the release in a browser.

Note: Before using this call, you'll need to authenticate against the API as detailed in Making your first call to the Project API.


Use this within an LMS to 'deeplink' to a course.

'name' (arg1) and 'email_address' (arg3) are optional parameters used to identify users.

'params' (arg4) is an optional parameter (e.g. &foo=bar&foo2=bar2) that will be passed on as a parameter to the xAPI Activity ID.

Release_code (arg1) is mandatory.

All of these examples have simulation mode turned on. Once you are ready to use in a production environment, you can remove the simulation parameter. Any changes will then affect your account.







$nonce = get_nonce('https://api.elucidat.com/v2/releases/launch', 'PUBLIC_KEY', 'PRIVATE_KEY');
$headers = auth_headers('PUBLIC_KEY', $nonce);
$fields = array(
    'release_code' => $arg1,
    'name' => $arg2,
    'email_address' => $arg3,
    'params' => $arg4,
    'simulation_mode' => 'simulation'
$result = call_elucidat($headers, $fields, 'GET', 'https://api.elucidat.com/v2/releases/launch', 'PRIVATE_KEY');
echo ("HTTP status code: " . $result['status'] . "\n");

Python 3.9

     endpoint = '/v2/releases/launch'
     method = 'GET'
     params = {'email_address': 'arg3',
               'release_code': 'arg1',
'params': 'arg4',
'simulation_mode': 'simulation'} data = {} api = Api(api_root, endpoint, method, params, data, private_key, public_key) api.call_elucidat()


"url": "https://learning.elucidat.com/go/OEp1bUhoMjlLaUNaaUppVG9vWWtzT1AzZ3ljaGljR1hHY3FZM0kydEtUbWR0emZOTm1tMXY4VGV3Sld2dTgwS2JzdVZCcGRrVlN0empDZUE3T0xERHVpSnVvbmJ1YTA2bkxKUitvdHFUcUFzNUZvS2dZR1BIeGRieEFiS2dER3dCQzFPclcvUXUyZkZRazd0WnRXMzVIS3hSOVd2dGtkRmVrRDZjbHlaDZnPQ%3D%3D",
"link_type": "temporary"

Was this article helpful?
0 out of 0 found this helpful

Articles in this section

See more
Request support
Access support that’s tailored to you by getting in touch with our Support Team.
Send us feedback
Do you have a new feature request, or want to tell us about something that works well (or not so well) for you? Get in touch!