Projekty a API klíče

Projekt

Pro konzumaci API je potřeba mít v portálu Můj účet vytvořený Projekt. Projekt zastřešuje aplikaci či skupinu aplikací, které spolu věcně nebo obchodně nebo jiným způsobem souvisí a účtují se dohromady.

Podrobnou definici Projektu najdete ve Smluvním ujednání, bod 1.3

Aplikace musí být celá provozována v rámci jednoho Projektu, je zakázáno rozdělovat jednu aplikaci do více Projektů
Věcně či obchodně související aplikace, musí být provozovány v rámci jednoho Projektu (např. webové stránky, android aplikace a iOS aplikace jednoho eShopu)
Hromadně distribuované aplikace (krabicová řešení) musí v rámci jednoho Projektu provozovat vždy nositel práv k této aplikaci (který má plnou kontrolou nad jejími zdrojovými kódy). Je zakázáno přenášet zakládání Projektů/API klíčů na koncové uživatele těchto aplikací.

API klíče v projektu

V rámci jednoho Projektu je možné provozovat jeden nebo více API klíčů. API klíč se pak předává při volání jednotlivých API funkcí jako identifikátor konzumenta.

Doporučujeme vytvořit např.

Jeden API klíč pro produkční web
Jeden API klíč pro mobilní aplikaci
Jeden API klíč pro vývoj/testování

Měsíční spotřeba se sčítá přes všechny API klíče v rámci projektu.

Správa API klíčů v rámci projektu

V nastavení jednotlivých klíčů

Můžete nastavit Zabezpečení pro konkrétní API klíč
Můžete povolit/zakázat konzumaci pomocí tohoto klíče

API klíč je možné smazat jen do té doby, než dojde k jeho použití. Jakmile je na klíči zaznamenaná konzumace, mazat již nejde (pak je možné pouze zakázat konzumaci s tímto klíčem).

Pozor, změna v nastavení či zabezpečení klíče se neprojeví hned, ale postupně během cca 15 minut.

Archivace projektů

Pokud projekt již nepoužíváte, můžete ho Archivovat na stránce Nastavení projektu. Archivované projekty nemohou konzumovat API a nechodí k nim ani žádné notifikace. Kdykoliv je možné projekt z archivu obnovit.