The described API should be available on an appropriate 3rd party side to receive either a private link to a course (or an embed code) that is hosted on Easygenerator’s side (this one is preferable, because it’s the fastest option and allows you to send the link once, and then it will be updated automatically when you make the updates), or to receive SCORM / HTML packages to store them on the 3rd party side (takes more time to load the package).
Please contact firstname.lastname@example.org and send us the following details to use the Publish to your platform API:
- Company name: The name of your company that will be displayed in Easygenerator.
- Company logo: The logo of your company that will be displayed in Easygenerator (max width: 130px, max height: 130px).
- API URLs: URLs to your API where Easygenerator will send the requests.
- Secret key: The secret key that the API will receive with each request. It must be validated. This key should be a randomly generated string.
NOTE: Direct publishing can be enabled for those users who use SSO vi LTI 1.2 to log-in into the Easygenerator authoring application from your platform.
Required API to receive courses from Easygenerator
This API should be available on the 3rd party side to receive courses from Easygenerator. The server, where Easygenerator is hosted, sends a request to the 3rd party server to provide a hosted course URL.
Note: /api/external/publishcourse is an example of the URL address. You can provide any URL you want.
Query string parameters:
- key: API key, provided by you. This key must be validated to confirm that our service sent the current request.
Request content type: application/json
Request body parameters:
- Id: Unique identifier of the course that will be published.
- userEmail: Email of the user who is publishing the course.
- publishedCourseUrl: The course URL that is published on Easygenerator hosting.
Example of the request body:
Response content type: text/plain (with error explanation)