https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=39900

Martin Renvoize (ashimema) <[email protected]> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
                 CC|                            |[email protected]
                   |                            |o.uk
  Text to go in the|                            |A new public REST API
      release notes|                            |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
           Keywords|release-notes-needed        |

-- 
You are receiving this mail because:
You are watching all bug changes.
_______________________________________________
Koha-bugs mailing list
[email protected]
https://lists.koha-community.org/cgi-bin/mailman/listinfo/koha-bugs
website : http://www.koha-community.org/
git : http://git.koha-community.org/
bugs : http://bugs.koha-community.org/

Reply via email to