BizKitHub

API

Z BizKitHub Docs, znalostní báze platformy

BizKitHub poskytuje REST API, které vám umožňuje integrovat naše služby do vašich aplikací. Veškerá komunikace probíhá přes HTTPS požadavky s JSON odpověďmi.

Základy

  • Základní URL: https://api.bizkithub.com
  • Autentizace: API klíč jako parametr dotazu (?apiKey=...)
  • Formát odpovědi: Všechny odpovědi jsou ve formátu JSON.

Jak to funguje

1. Získejte svůj API klíč

Nejprve musíte získat API klíč z administračního panelu BizKitHub. API klíč autentizuje všechny vaše požadavky. Viz Jak získat API klíč.

2. Provádějte HTTPS požadavky

Všechny API volání se provádějí jako standardní HTTPS požadavky. Parametr apiKey je vždy povinný a musí být zahrnut jako parametr dotazu v URL.

3. Zpracování JSON odpovědi

Každý API endpoint vrací JSON odpověď. Přesná struktura závisí na endpointu a je podrobně zdokumentována v naší Swagger dokumentaci.

Ukázkový požadavek

fetch('https://api.bizkithub.com/api/v1/calendar/detail?apiKey=YOUR_API_KEY&code=EVENT_CODE')
.then(response => response.json())
.then(data => console.log(data));

Povinný parametr

Parametr dotazu apiKey je povinný pro všechny API požadavky. Požadavky bez platného API klíče budou zamítnuty.

API Endpoints

Pro kompletní seznam všech dostupných endpointů, včetně parametrů požadavku a formátů odpovědi, se prosím podívejte na naši interaktivní Swagger dokumentaci. Můžete také získat API klíč z administračního panelu.

Struktura URL

Každý veřejný endpoint na api.bizkithub.com následuje předvídatelnou šablonu cesty:

/<module>/<version>/<service>/<action>

modul identifikuje podnikatelskou oblast (shop, product, contact, calendar, newsletter, ping, …). verze je vždy číslo začínající na v (v1); pokud nevíte, kterou verzi cílit, použijte v1. Nepovinný service a action zužují na konkrétní endpoint.

Minimální dobře formovaná cesta je /<module>/<version>, například /ping/v1. Reprezentativní plně kvalifikované URL — vytvoření objednávky — vypadá takto:

POST https://api.bizkithub.com/shop/v1/order/create

Konvence HTTP metod

Každý endpoint dokumentuje HTTP metodu, kterou přijímá. Podle konvence:

  • GET — endpointy pro načítání. Idempotentní; bezpečné znovu vyzkoušet.
  • POST — vytváření, přechody a jakýkoli endpoint, který mění stav serveru.

Endpointy, které musí přijímat velké nebo strukturované tělo — vytváření objednávky, hromadné importy, složité vyhledávání — používají POST i když jsou konceptuálně pro načítání. Když máte pochybnosti, odkazujte na interaktivní Swagger dokumentaci; každý endpoint tam deklaruje svou přesnou metodu.

Jak předat API klíč

Parametr apiKey může být dodán prostřednictvím jakéhokoli kanálu — vyberte ten, který nejlépe vyhovuje vaší integraci:

V URL dotazu (typické pro GET):

GET https://api.bizkithub.com/api/v1/ping/v1?apiKey=YOUR_API_KEY

V JSON těle požadavku (typické pro POST):

{
"apiKey": "YOUR_API_KEY",
"customerEmail": "[email protected]"
}

Oba kanály jsou akceptovány na každém endpointu a mohou být kombinovány — důležité je, aby byl klíč dodán alespoň jednou. Pro podrobnosti o formátech klíčů, předponách a standardech rychlostních limitů se podívejte na článek o API klíči.

Rychlá kontrola zdraví

Pro ověření, že váš klíč a síťová cesta fungují od začátku do konce, navštivte endpoint ping z prohlížeče nebo curl:

GET https://api.bizkithub.com/ping/v1?apiKey=YOUR_API_KEY

Úspěšná odpověď potvrzuje, že brána obdržela váš požadavek, vyřešila váš klíč a dosáhla platformy.

Související témata

Související

Stránka byla naposledy upravena 24. července 2026.