The list of API endpoints is self-explanatory, making it easier for you to navigate and comprehend. To gain a better understanding of the request and response body structure, you can download the Postman dump and try it out yourself.
Tables of contents
- API Endpoints Supported
- API Versions and Postman Dump
- Migrate from API version 1.0 to 1.1
- Migrate from API version 1.1 to 1.2
API Endpoints Supported
Below is a comprehensive list of the API endpoints supported by Knorish.
User Endpoints
- GetUserLiveSessions
- GetUserBundles
- GetUsers
- GetUser
- CreateUser
- UpdateUser
- RemoveUser
- GetUserCourses
- GetUserCourseProgress
- AddUserInCourse
- RemoveUserFromCourse
- AddUserInBundle
- RemoveUserFromBundle
- GetUserPasswordResetUrl
- GetUserAutoLoginUrl
- UpdateUserPassword
Course Endpoints
- GetCourses
- GetCourse
- RemoveCourse
- GetCourseUsers
- GetCourseSections
- GetCourseChaptersBySectionId
- GetCourseAssessments
- GetCourseLiveSessions
Bundle Endpoints
- GetBundles
- GetBundleUsers
- GetBundleCourses
- GetBundle
- RemoveBundle
API Versions and Postman Dump
API v1.2 - Postman dump - https://drive.google.com/file/d/1rAOR6NTZfxVc0FUGAe4kAxM4VvzFWzTo/view?usp=sharing
Migrate from API version 1.0 to 1.1
In the updated version, we have made changes to the CreateUser endpoint by separating the mobile number and dialing code into separate parameters. Previously, in version 1.0, the mobile number included the dialing code as a single value. However, in the current version, both the mobile number and the dialing code need to be passed as separate parameters. This allows for more flexibility and accuracy in specifying the user's contact details.
JSON body of v1.0 request
POST https://api.knorish.com/publisher/v1.0/user/CreateUser
{
"name": "User1",
"email": "user1-postman@knorish.training",
"mobile": "+917896541230",
"sendinvite": true
}
JSON body of v1.1 request
POST https://api.knorish.com/publisher/v1.1/user/CreateUser
{
"name": "User1",
"email": "user1-postman@knorish.training",
"mobile": "7896541230",
"dialingcode": "+91",
"sendinvite": true
}
Migrate from API version 1.1 to 1.2
In the updated version, we made changes to the GetCourse endpoint due to a change in course pricing, which now enables us to create unlimited price points for a single course. This approach aligns with how pricing was handled in bundles and was implemented to support multiple currencies in courses and bundles. In GetCourse v1.2 we are removing inrprice, usdprice and expireafterdays from body.
JSON body of v1.1 request
GET https://api.knorish.com/publisher/v1.1/course/GetCourse?id=9bd737f5-6b7a-4465-a728-cf80ee1ddb8d
{
"id": "9bd737f5-6b7a-4465-a728-cf80ee1ddb8d",
"name": "Course Name",
"thumbnail": "https://path.net/image-5.png",
"ispublish": 0,
"isfeatured": 1,
"ishiddencourse": 0,
"inrprice": 0.00,
"usdprice": 0.0,
"certallowed": false,
"readerlevel": 1,
"language": 1,
"expireafterdays": 0,
"chatallowed": true,
"limitcoursesales": 0,
"showassessmentresult": false
}
JSON body of v1.2 request
GET https://api.knorish.com/publisher/v1.2/course/GetCourse?id=9bd737f5-6b7a-4465-a728-cf80ee1ddb8d
{
"id": "9bd737f5-6b7a-4465-a728-cf80ee1ddb8d",
"name": "Course Name",
"thumbnail": "https://path.net/image-5.png",
"ispublish": 0,
"isfeatured": 1,
"ishiddencourse": 0,
"certallowed": false,
"readerlevel": 1,
"language": 1,
"chatallowed": true,
"limitcoursesales": 0,
"showassessmentresult": false
}
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article