BizKitHub

API klíč

Z BizKitHub Docs, znalostní báze platformy

Každý požadavek na REST API BizKitHub je autentizován pomocí API klíče. Klíč identifikuje volající organizaci, její povolené rozsahy a úroveň limitu. Bez platného klíče je požadavek odmítnut ještě před tím, než se spustí jakýkoli zpracovatel.

Co je API klíč

Každý požadavek na REST API BizKitHub je autentizován pomocí API klíče. Klíč identifikuje volající organizaci, její povolené rozsahy a úroveň limitu. Bez platného klíče je požadavek odmítnut ještě před tím, než se spustí jakýkoli zpracovatel.

Formát klíče

Klíče jsou dlouhé 32 znaků. První čtyři znaky jsou prefix, který označuje typ klíče, následovaný 28 náhodnými alfanumerickými znaky.

Prefix Typ Účel Limit
PROD Produkce Živé aplikace a integrace Vysoký
DEV_ Vývoj Lokální vývoj, testování, sandboxing Nízký
ROOT Systém Vyhrazeno pro údržbu na úrovni platformy Neomezený

Celý vzor je /^(PROD|DEV_|ROOT)[a-zA-Z0-9]{28}$/. Klíče jsou generovány s kryptograficky bezpečným náhodným zdrojem a jsou globálně jedinečné.

Předání klíče

Zahrňte klíč jako parametr apiKey buď do dotazovacího řetězce, nebo do JSON těla. Každý koncový bod přijímá obě možnosti.

Dotazovací řetězec

GET https://api.bizkithub.com/api/v1/order/list?apiKey=VÁŠ_API_KLÍČ

Tělo požadavku

{
"apiKey": "VÁŠ_API_KLÍČ",
"customerId": "cus_abc123"
}

Ověřovací pipeline

Každý požadavek je validován v následujícím pořadí:

  1. Přítomnost — klíč musí být poskytnut v dotazu nebo těle.
  2. Formát — musí odpovídat vzoru prefixu + 28 znaků.
  3. Registr — klíč musí existovat a být aktivní v databázi organizace.
  4. Expirace — prošlé nebo zrušené klíče jsou odmítnuty.
  5. Limit — volající musí být v rámci svého limitu za minutu.
  6. Oprávnění — vyřešená organizace musí mít povolení volat koncový bod.

Teprve po úspěšném splnění všech šesti kontrol se spustí zpracovatel koncového bodu.

Bezpečné zacházení s klíči

  • Uložte klíče do proměnných prostředí. Nikdy je nezapomeňte uložit do repozitáře.
  • Používejte klíče DEV_ pro místní vývoj, aby únik nemohl zasáhnout produkční data.
  • Pravidelně rotate produkční klíče a okamžitě, pokud je podezření na únik.
  • Vždy volejte API přes HTTPS. Čisté HTTP je odmítnuto.
  • Nezaznamenávejte plnou hodnotu klíče do aplikačních logů nebo chybových zpráv.

Klíče jsou vytvářeny a rotovány z administračního panelu BizKitHub v sekci Systém → API klíče.

Související

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