Skip to main content

Ebooks (CURRENTLY DEPRECATED)

This section covers the API endpoints for managing ebooks in the system.

List Ebooks

Retrieve a paginated list of active ebooks.

GET /v1/customer/ebooks

Query Parameters

ParameterTypeDescription
per_pageintegerNumber of items per page (default: 10)
pageintegerPage number for pagination

Response

{
"status": true,
"message": "Data retrieved successfully",
"data": {
"current_page": 1,
"online_books": [
{
"id": 1,
"title": "Example Ebook",
"description": "Book description",
"image": "path/to/image.jpg",
"is_favorite": false
}
],
"first_page_url": "...",
"last_page_url": "...",
"next_page_url": "...",
"prev_page_url": null,
"total": 20,
"seo": {
"title": "Ebooks",
"description": "Browse our collection of ebooks"
}
}
}

Get Ebook Details

Retrieve detailed information about a specific ebook.

GET /v1/customer/ebooks/{id}

Path Parameters

ParameterTypeDescription
idintegerID of the ebook

Query Parameters

ParameterTypeDescription
viewbooleanIf true, allows viewing soft-deleted ebooks (optional)

Response

{
"status": true,
"message": "Data retrieved successfully",
"data": {
"id": 1,
"title": "Example Ebook",
"description": "Detailed book description",
"image": "path/to/image.jpg",
"has_summary": true,
"can_download_summary": true,
"watch_also": [
{
"id": 2,
"title": "Related Ebook",
"image": "path/to/image.jpg"
}
],
"ebooks_favorites": []
}
}

Download Ebook Summary

Download the summary of a specific ebook if available and permitted.

GET /v1/customer/ebooks/{id}/download-summary

Path Parameters

ParameterTypeDescription
idintegerID of the ebook

Response

On success, returns a ZIP file containing the ebook summary.

On failure:

{
"status": false,
"message": "You are not subscribed to access this content"
}

Notes

  • The summary can only be downloaded if:
    • The ebook has a summary available (has_summary is true)
    • The user has permission to download the summary (can_download_summary is true)
  • The summary is delivered as a ZIP file containing the relevant documents