README

This is an unofficial composer package of the original eFrontPRO-SDK from Epignosis. It aims to improve simplicity as well as maintaining/adding endpoints from the official documentation provided on Swaggerhub page.

Installation

This package can be installed with composer require weisl/efront-php-sdk.

Usage

use Weisl\EFrontSDK\EFrontAPI;

...

$api = new EFrontAPI("1.0", "https://your-efront-domain.com/API", "your-api-key");
$api->GetAPI('System')->GetInfo();
$api->GetAPI('CourseUser')->AddRelation($userId, $courseId);

Contributing

You can contribute to this project in every way you like. If you encounter any errors or spot missing endpoints, feel free to contact me.

Testing

In order to test the application, you need to set apiVersion, apiLocation and apiKey accordingly. See /tests/SimpleApiTest.php for an example.

Run the tests with: vendor/bin/phpunit

Documentation

The authors provided the following documentation via GitHub.

License

GNU GENERAL PUBLIC LICENSE

Supported Endpoints

Endpoint	Method	Support
/user-types	GET	✅
/user-type/{id}	GET	✅
/training-sessions	GET	✅
/training-session/{id}	GET	✅
/course/{id}/training-sessions	GET	✅
/training-session/{id}/users	GET	✅
/Plugins	GET	✅
/Plugin/{pluginName}	GET	✅
/Plugin/{pluginName}	POST	✅
/Autologin/{loginName}	GET	✅
/Users	GET	✅
/Logout/{loginName}	GET	✅
/Users/{id}	GET	✅
/Users/{id}	PUT	✅
/Users/{eMailAddress}	GET	✅
/User	POST	✅
/User/{Id}/Activate	PUT	✅
/User/{Id}/Deactivate	PUT	✅
/Branch/{Id}	GET	✅
/Branches/	GET	✅
/Branch	POST	✅
/Branch/AddUser	POST	❌ --> ✅ v1.0.0
/Branch/{Id}/AddUser	PUT	✅
/Category/{Id}	GET	✅
/Categories	GET	✅
/Course/{Id}	GET	✅
/Course/{CourseId}/UserProgress/{UserId}	GET	❌ --> ✅ v1.0.3
/CourseUserTestAttempts/{CourseId},{UserId}	GET	❌ --> ✅ v1.0.3
/Courses	GET	✅
/Course/{Id}/Content	GET	❌ --> ✅ v1.0.3
/Course	POST	❌ --> ✅ v1.0.3
/Course/{Id}/AddUser	PUT	✅
/Course/{Id}/RemoveUser	PUT	✅
/CourseUserStatus/{CourseId},{UserId}	GET	✅
/CourseUserStatus/{CourseId},{UserId}	POST	✅
/CourseUserStatus	POST	❌ --> ✅ v1.0.3
/Course/AddUser	POST	❌ --> ✅ v1.0.3
/curriculums	GET	✅
/Curriculum/{Id}/AddUser	PUT	✅
/Curriculum/{Id}/RemoveUser	PUT	✅
/User/{Id}/Catalog/	GET	✅
/Group/{Id}	GET	✅
/Groups	GET	✅
/Group/AddUser	POST	❌ --> ✅ v1.0.3
/Group/{Id}/AddUser	PUT	✅
/Group/{Id}/RemoveUser	PUT	✅
/Job/{Id}/RemoveUser	PUT	✅
/Job/{Id}	GET	✅
/Job/{Id}	PUT	✅
/Jobs	GET	✅
/User/{Id}/Jobs	GET	❌ --> ✅ v1.0.3
/Job/AddUser	POST	❌ --> ✅ v1.0.3
/Job	POST	✅
/Job/{Id}/AddUser	PUT	✅
/extended-fields/users	GET	✅
/System/Info	GET	✅
/Content/{id}	GET	✅
/Account/Status	POST	✅

weisl/efront-php-sdk

包简介

README 文档