BizKitHub Developer Documentation

Parameters

9 query

Query parameters

· 9

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-oxendict → en-GB → en (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: 2–35

Examplecs

searchstringOptional

Fulltext over term/abbreviation/notes (accent-insensitive).

Exampleexample_search

categoryIdstringOptional

Filter by category public id (16-char).

Exampleexample_categoryId

categorySlugstringOptional

Filter by category canonical slug in the requested locale. Convenient when the frontend routes on the category page URL and does not want a lookup round-trip. Ignored when categoryId is also passed.

Examplekryptografie-a-sifrovani

letterstringOptional

Restrict to terms starting with this letter (case-insensitive, accent-folded).

ExampleA

sort"alphabetical" | "newest" | "updated"Optional

Ordering. Defaults to alphabetical.

pagestringOptional

1-based page index. Default 1.

Exampleexample_page

limitstringOptional

Items per page. Default 50, max 500.

Exampleexample_limit

Response schema

1 status code documented

200Success

itemsobject[]Required

Each array item:

idstringRequired

Example6IU2SWgP76FO2UXw

slugstring | nullRequired

One of 2:

Variant 1

string

Exampleaes

Variant 2

null

termstringRequired

ExampleAES

abbreviationstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

categoryobject | nullRequired

One of 2:

Variant 1

slugstring | nullRequired

One of 2:

Variant 1

string

Variant 2

null

namestringRequired

Variant 2

null

definitionCountnumberRequired

aliasCountnumberRequired

publishedDateDate | string | string | numberOptional

One of 4:

Variant 1

Date

Variant 2

stringdate-time

Variant 3

stringdate

Variant 4

number

updatedDateDate | string | string | numberRequired

One of 4:

Variant 1

Date

Variant 2

stringdate-time

Variant 3

stringdate

Variant 4

number

itemCountnumberRequired

Total number of matching terms across all pages.

Response example

application/json

{
  "items": [
    {
      "id": "6IU2SWgP76FO2UXw",
      "term": "AES",
      "definitionCount": 0,
      "aliasCount": 0
    }
  ],
  "itemCount": 0
}

/api/v1/glossary/list

Parameters

Query parameters

Response schema

Response example

Request example

Need an API key?