|
|
|
|
Reported:
|
2025-05-14 12:32 UTC by Pedro Amorim
|
|
Modified:
|
2025-10-10 12:08 UTC
(History)
|
|
|
8
users
(show)
|
|
|
See Also:
|
|
|
GIT URL:
|
|
|
Initiative type:
|
---
|
|
Crowdfunding goal:
|
0
|
|
Patch complexity:
|
Small patch
|
|
Documentation contact:
|
|
|
Documentation submission:
|
|
|
Text to go in the release notes:
|
A new public REST API endpoint has been added for retrieving additional contents (news items and HTML customisations) without authentication. This enables external applications and websites to access and display Koha news and custom content.
**Endpoint details:**
- **Path:** `/api/v1/public/additional_contents`
- **Method:** GET
- **Authentication:** None required (public endpoint)
- **Query parameters:**
- Standard search and filter parameters for finding specific content
- `lang`: Filter by language code to retrieve content in a specific language
- `embed`: Use `translated_contents` to include all available translations
**Key features:**
- **Public access**: No authentication required, making it suitable for displaying library news on external websites
- **Multi-language support**: Retrieve content in specific languages or fetch all translations at once using the `translated_contents` embed
- **Flexible filtering**: Search and filter additional contents using standard API query parameters
- **Content types**: Access both news items and HTML customisations through the same endpoint
**For developers:**
This endpoint follows the same patterns as other Koha public API endpoints. Use the `lang` parameter to retrieve content for a specific language, or use `embed=translated_contents` to get all available translations in a single request. This is particularly useful for multi-lingual library websites that need to display Koha news items.
**Example use cases:**
- Displaying library news on an external website
- Integrating OPAC announcements into a library portal
- Building mobile applications that show library notices
- Creating custom displays of library information
|
|
Version(s) released in:
|
25.11.00,25.05.04
|
|
Circulation function:
|
|
|
|