Errors

Code Description
404 Couldn't find tool provider with 'id'=':tool_provider_id'
401 You are not authorized to access this page.

Examples

{
    'example_request_params': {
        'id': 1,
        'nonce': 1527500365,
        'timestamp': 1527500365052,
        'signature': '8aac70c9906ad0812f4fbc34617322f985b4ac978cec861724f142cb572b88ff'
    },
    'example_response': {
        'tool_provider': {
            'id': 1,
            'tool_name': 'some name',
            'tool_url': 'https://example.com/lti',
            'oauth_consumer_key': 'key',
            'oauth_consumer_secret': 'secret',
            'institute_id': 1,
            'created_at': '2020-11-26T07:19:53.143+01:00',
            'updated_at': '2020-11-26T07:19:53.143+01:00',
            'use_as_basic_link': true,
            'lti_custom_data': '{}'
        }
    }
}

Params

Param name Description
id
required

ID of the tool provider.

Validations:

  • Must be a number.

timestamp
required

Timestamp of the request in milliseconds.

Validations:

  • Must be a number.

nonce
required

Random number unique between the api calls made in the previous 24 hours.

Validations:

  • Must be a number.

signature
required

HMAC sha256 hex encoded hash, using the user secret_key as key, of the query string build with all the other parameters in the format 'name=value' joined by '?' and ordered alphabethically by name. Do not use encoding scheme on the values you use to calculate the string

Validations:

  • Must be a String