BizKitHub
DocsAPI ReferencePost/api/v1/post/rss
getPostPublic API v1

/api/v1/post/rss

Returns an RSS 2.0 XML feed of published posts for the given locale. Response Content-Type is application/rss+xml.

Filters: mainCategory (category route slug), tag (tag code) and author (author profileSlug = shop__contact.external_id) narrow the feed. All three may be combined and are optional.

Full-body syndication: set fullContent=true to embed the raw HTML body of each post inside <content:encoded><![CDATA[…]]></content:encoded> (the standard RSS content-module extension). When omitted or false, only the short teaser (<description>) is emitted.

postgetApiV1PostRss

Parameters

6 query

Query parameters

· 6
apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE
localestringRequired

Communication locale code — controls the language of textual data (product names, descriptions, articles, storefront UI, transactional e-mails).

Preferred format: BCP 47 language tag — language[-Script][-REGION]. Use the full tag whenever the script or region matters:

  • en-GB vs. en-US (British vs. American spelling)
  • pt-PT vs. pt-BR (European vs. Brazilian Portuguese)
  • zh-Hans vs. zh-Hant (Simplified vs. Traditional Chinese)
  • sr-Latn vs. sr-Cyrl (Latin vs. Cyrillic Serbian)

Backwards-compatible fallback: the bare two-letter ISO 639-1 code (cs, en, pl, …) is accepted indefinitely — legacy clients that only send the language subtag continue to work unchanged.

Resolution algorithm (server-side): the input is resolved against the supported locale list via the [RFC 4647 Lookup] progressive-fallback strategy — trailing subtags are stripped one by one until a supported locale is found. Example: en-GB-oxendicten-GBen (matched). If no subtag combination is supported, the request is rejected.

Currently supported locales: cs, en, fr, it, pl, de, sk, sv, es, zh, ja, uk, da, hu, ro, nl, pt, fi, nb, hr. Region-specific variants (e.g. en-GB, pt-BR) are accepted and resolved to their base language when the exact variant is not registered separately.

Length: 235
Examplecs
mainCategorystringOptional

Optional main category route slug to filter posts. Only posts whose mainCategory matches this slug will be included in the feed. Same semantics as /post/feed.

Examplenovinky
tagstringOptional

Optional tag code to filter posts. Only posts that have this tag assigned will be included. The tag must be active and belong to the same organisation. Same semantics as /post/feed.

Examplenovinky
authorstringOptional

Optional author profile slug (the contact's profileSlug — i.e. shop__contact.external_id as exposed by /post/post). Filters posts by main_author_id matching this contact.

Example71E58E5SjdZN6ut3
fullContentbooleanOptional

When true, each <item> includes the full HTML body of the post as <content:encoded><![CDATA[…]]></content:encoded> (the standard RSS content-module extension). When false or omitted, the current teaser-only behavior is preserved.

Default: false
Exampletrue

Response schema

1 status code documented

200Success

This response returns no JSON body.

Response example

application/json
{
  "success": true
}

Request example

GET /api/v1/post/rss

get
curl -X GET "https://api.bizkithub.com/api/v1/post/rss?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&locale=cs&mainCategory=novinky&tag=novinky&author=71E58E5SjdZN6ut3&fullContent=true" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key