jeontwikkeling-nl / ltisaas_client_api_php
<p>A brief overview of the API versions:</p> <ul> <li><strong>v0:</strong> This version is solely for testing and does not interact with the database, nor does it involve any validation. It simply serves mock data.</li> <li><strong>v1:</strong> This is the official version of the LtiSaas API, intend
Requires
- php: ^8.1
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpunit/phpunit: ^8.0 || ^9.0
This package is auto-updated.
Last update: 2025-07-01 17:43:57 UTC
README
A brief overview of the API versions:
- v0: This version is solely for testing and does not interact with the database, nor does it involve any validation. It simply serves mock data.
- v1: This is the official version of the LtiSaas API, intended for production use.
Please be informed that when testing version v0, the HTTP Access-Token
header should be set with the value 'dummy'.
Also, please note that the API has a limit of 2500 results per response.
Additionally, all webservices support both POST and GET requests. However, the POST method is required when uploading files.
Installation & Usage
Requirements
PHP 8.1 and later.
Composer
To install the bindings via Composer, add the following to composer.json
:
{ "repositories": [ { "type": "vcs", "url": "https://github.com/jeontwikkeling-nl/ltisaas_client_api_php.git" } ], "require": { "jeontwikkeling-nl/ltisaas_client_api_php": "*@dev" } }
Then run composer install
Manual Installation
Download the files and include autoload.php
:
<?php require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: token $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer'); $apiInstance = new LtiSaasApi\Api\CoursesApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $coursename = 'coursename_example'; // string | The name of the course to be created $coursenameshort = 'coursenameshort_example'; // string | The shortname of the course to be created try { $result = $apiInstance->courseAdd($coursename, $coursenameshort); print_r($result); } catch (Exception $e) { echo 'Exception when calling CoursesApi->courseAdd: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://linqur45.web09.webv.nl/local/ltisaas/api.php/v0
Class | Method | HTTP request | Description |
---|---|---|---|
CoursesApi | courseAdd | GET /course/add | Create a new course |
CoursesApi | courseDelete | GET /course/delete | Delete an existing course by its ID |
CoursesApi | courseGradeSet | POST /course/grade | Set or reset a user's course grade |
CoursesApi | courseList | GET /course/list | Retrieve all courses |
CoursesApi | courseUpdate | GET /course/update | Update an existing course |
LTIAnalyticsApi | courseLtiRegistrationsByDay | GET /course/lti/registrations_by_day | Get LTI registrations by day |
LTIAnalyticsApi | courseLtiRegistrationsSumByCourse | GET /course/lti/registrations_sum_by_course | Get total LTI registrations per course |
LTIToolsApi | courseToolAdd | GET /course/tool/add | Add new tool to a course |
LTIToolsApi | courseToolDelete | GET /course/tool/delete | Delete a specific course tool |
LTIToolsApi | courseToolList | GET /course/tool/list | List all LTI tools within a course |
LTIToolsApi | courseToolUpdate | GET /course/tool/update | Update a specific course tool |
LearningObjectsApi | courseLearningObjectDelete | GET /course/learningobject/delete | Delete a specific learning object |
LearningObjectsApi | courseLearningObjectScromAdd | POST /course/learningobject/scrom/add | Add an SCORM package to a course |
LearningObjectsApi | courseLearningobjectList | GET /course/learningobject/list | Get learning objects for a course |
LearningObjectsApi | courseLearningobjectScormUpdate | POST /course/learningobject/scrom/update | Update SCORM Learning Object |
MembersApi | memberList | GET /member/list | Get a list of LTI system members that are unique on the system |
TokensApi | tokenAdd | GET /token/add | Add a new API token |
TokensApi | tokenDelete | GET /token/delete | Delete an API token |
TokensApi | tokenList | GET /token/list | Get list of API tokens |
UsersApi | userDelete | GET /user/delete | Delete a user by ID |
UsersApi | userDeleteBulk | GET /user/delete_bulk | Delete multiple users by IDs |
UsersApi | userList | GET /user/list | Get list of users in a tool |
Models
- CourseAdd200Response
- CourseDelete200Response
- CourseGradeSet200Response
- CourseGradeSet400Response
- CourseLearningObjectScromAdd200Response
- CourseLearningobjectList200Response
- CourseLearningobjectList200ResponseResultsInner
- CourseList200Response
- CourseList200ResponseResultsInner
- CourseLtiRegistrationsByDay200Response
- CourseLtiRegistrationsByDay200ResponseResultsInner
- CourseLtiRegistrationsSumByCourse200Response
- CourseLtiRegistrationsSumByCourse200ResponseResultsInner
- CourseToolAdd200Response
- CourseToolList200Response
- CourseToolList200ResponseResultsInner
- CourseUpdate200Response
- ErrorResponse
- MemberList200Response
- MemberList200ResponseResultsInner
- TokenAdd200Response
- TokenList200Response
- TokenList200ResponseResultsInner
- UserList200Response
- UserList200ResponseResultsInner
Authorization
Authentication schemes defined for the API:
token
- Type: API key
- API key parameter name: Access-Token
- Location: HTTP header
Tests
To run the tests, use:
composer install vendor/bin/phpunit
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
1.0
- Generator version:
7.14.0
- Generator version:
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen