API Endpoints and Postman Dump - Publisher REST API

API Endpoints and Postman Dump - Publisher REST API

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.

API Endpoint List

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

Swagger UI and Postman Dump

Swagger UI-https://api.knorish.com/swagger/index.html

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

}



    • Related Articles

    • Getting started - Publisher REST API

      Knorish is home to tens of thousands of businesses, experts and course creators around the world that arebuilding a business using online education. At Knorish we ensure that all course creators have the tools and resources to solve the most ...

    • Authorization using App Id and App Key - Publisher REST API

      If you want a simple way to gain access to the API for an individual Knorish Site with the purpose of building a private or one-off app, you can authorize using the Knorish Site's App Id and App Key. Generate App ID and App Key To generate App Id and ...

    • Request and response format - Publisher REST API

      All data in request or response from the API is in JSON format. Request and response fields for every API endpoint will be different, and you will know about them individually. Date Format All dates and timestamps are returned and expected in ISO ...

    • Rate Limit - Publisher REST API

      To ensure Knorish remains stable and accessible to all sites, we limit the number of requests per 5 minutes that any one Site can make to the API. Consumers of the API should take steps to ensure they are using industry standard techniques to ...

    • How to use Webhooks in Knorish

      Introduction Webhooks are a powerful feature within Knorish that provides near-real-time information about specific events as they happen in your account. They allow you to automate workflows, share data, or build custom apps by sending an HTTP ...