Aplikace s přístupem k Api#
Api je vstup do webu pro programy: vaši mobilní aplikaci nebo systém partnera, který si z webu bere inzeráty, produkty či objednávky. Každá taková aplikace se musí při každém požadavku prokázat klíčem aplikace. Klíče vydáváte a spravujete na této obrazovce. Aplikace může mít víc klíčů a každý může mít datum, kdy přestane platit — klíč tak vyměníte bez výpadku.
Obrazovku najdete v Nastavení → Aplikace s přístupem k Api (odkaz Nastavení úplně dole v levém sloupci, viz Nastavení). Vidí ji jen administrátor.
Co klíč aplikace dělá#
- Klíč říká jen to, že aplikace smí Api volat. Bez platného klíče Api aplikaci odmítne.
- Jaká data aplikace dostane, rozhodují práva uživatele, který je v ní přihlášený — stejně jako na webu. Když se v aplikaci nikdo nepřihlásí, vidí aplikace jen to, co návštěvník webu.
- Web a administrace klíč nepotřebují. Klíč je jen pro programy mimo web.
- U každé aplikace nastavíte, kolik požadavků smí poslat a které uživatelské role se přes ni smějí použít.
Kdo klíč potřebuje
Klíč patří programu, ne člověku. Návštěvníci webu ani administrátoři ho nikdy nezadávají. Vývojáři aplikace ho předáte jednou, ten ho vloží do aplikace nebo na svůj server.
Přehled aplikací#
V tabulce vidíte u každé aplikace:
| Sloupec | Co znamená |
|---|---|
| Název | jak jste aplikaci pojmenovali |
| Klíče | kolik má aplikace platných klíčů, např. 2 platné. Za tečkou se ukáže, kolik klíčů brzy vyprší (s datem), kolik už vypršelo a kolik je zrušených (šedě) |
| Stav | Aktivní, Vypnutá nebo Zrušená |
| Za sekundu, Za minutu | kolik požadavků smí poslat celá aplikace; výchozí (20) znamená, že platí výchozí hodnota webu |
| Povolené role | role, které se přes aplikaci smějí použít. Role s rozšířenými právy (např. Administrátor) je zvýrazněná |
| Naposledy použita | kdy aplikace naposledy poslala požadavek (zapisuje se nejvýš jednou za minutu) |
| Založena | kdy jste aplikaci založili |
Tlačítka v řádku: editovat, Klíče (stránka klíčů aplikace), Vypnout / Zapnout a Zrušit. U zrušené aplikace zůstává jen Klíče — vypršelé a zrušené klíče tam můžete smazat.
Založení aplikace#
- Klikněte na přidat nad tabulkou.
- Vyplňte Název, podle kterého aplikaci poznáte (např. „Mobilní aplikace“ nebo jméno partnera). Poznámka je jen pro vás — kdo aplikaci provozuje, kontakt apod.
- Limity nechte prázdné, pokud nevíte, že aplikace potřebuje jiné (viz Limity požadavků).
- Zkontrolujte Povolené role (viz Povolené role). Předvyplněné jsou role běžných uživatelů.
- V části První klíč můžete klíči dát Popisek (např. „verze 2.1“) a datum Platí do. Obojí je nepovinné — prázdné Platí do znamená, že klíč platí, dokud ho nezrušíte.
- Klikněte na Uložit.
Po uložení se vrátíte na přehled a nahoře uvidíte klíč aplikace.
Uložení klíče#
Klíč se ukáže jen jednou — hned po založení aplikace (na přehledu) nebo po vydání dalšího klíče (na stránce Klíče). Web si ho neukládá, má jen jeho otisk, takže ho už nikdy znovu nezobrazí.
- Klikněte na Kopírovat vedle klíče (nebo klíč v poli označte a zkopírujte).
- Uložte ho hned na bezpečné místo (správce hesel) nebo ho předejte vývojáři aplikace.
- Teprve potom stránku opusťte. Po obnovení stránky už klíč uvidíte jen jako jeho začátek (prvních 16 znaků) na stránce Klíče.
Klíč posílejte bezpečně
Neposílejte klíč běžným e-mailem ani do chatu, kde zůstane uložený. Kdo klíč má, může Api volat za vaši aplikaci. Když klíč ztratíte nebo máte podezření, že unikl, vydejte nový klíč a starý zrušte.
Aplikace posílá klíč v hlavičce X-API-Key u každého požadavku. Podrobnosti pro vývojáře
jsou v části Autentizace.
Limity požadavků#
Limity chrání web před přetížením. Když je aplikace překročí, dostane chybu „příliš mnoho požadavků“ s údajem, za jak dlouho to má zkusit znovu. Každý limit je celé číslo od 1 do 1 000 000; prázdné pole znamená výchozí hodnotu webu, která je napsaná přímo v poli.
| Pole | Co omezuje | Výchozí |
|---|---|---|
| Celá aplikace za sekundu | všechny požadavky aplikace dohromady za jednu sekundu (špičky) | 20 |
| Celá aplikace za minutu | všechny požadavky aplikace dohromady za minutu (trvalá zátěž) | 600 |
| Přihlášený uživatel za minutu | požadavky jednoho přihlášeného uživatele aplikace | 120 |
| Jedna adresa za minutu | požadavky nepřihlášeného uživatele z jedné adresy | 120 |
Limity platí hned po uložení.
Vlastní mobilní aplikace potřebuje víc
Limit celé aplikace sdílejí všichni její uživatelé. Přes vaši mobilní aplikaci může jít hodně lidí najednou, proto jí nastavte vyšší limity než aplikaci jednoho partnera. Limit na adresu může být málo i tam, kde je za jednou adresou víc lidí (mobilní operátor, firma).
Povolené role#
Přes aplikaci platí jen zaškrtnuté role. Má-li přihlášený uživatel i jinou roli, aplikace s ním zachází, jako by ji neměl. Například administrátor, který se přihlásí do aplikace partnera bez povolené role Administrátor, v ní dostane jen to, co běžný přihlášený uživatel.
Role Nepřihlášený je povinná: je vždy zaškrtnutá a odškrtnout ji nejde. Volání bez přihlášení i samotné přihlášení se vyhodnocují touto rolí — bez ní by se v aplikaci nedalo ani přihlásit.
Nová aplikace má předvyplněné:
| Role | Proč |
|---|---|
| Nepřihlášený (povinná) | aplikace bez přihlášení vidí to, co návštěvník webu; přes tuto roli se uživatel přihlašuje |
| Přihlášený uživatel | přihlášený uživatel vidí to, co na webu |
| Vlastník | uživatel může upravovat své záznamy (např. svůj inzerát) |
| Příjemce | uživatel může číst, co je určené jemu (např. reakce na svůj inzerát) |
Role s rozšířenými právy jsou označené štítkem rozšířená práva a upozorněním „Uživatel s touto rolí bude moci přes aplikaci spravovat web“. Zaškrtněte je jen u aplikace, které plně věříte — typicky u vlastní aplikace pro správu webu, nikdy u aplikace partnera.
Aplikace jen pro veřejná data
Když odškrtnete všechny role kromě povinné role Nepřihlášený, aplikace dostane jen to, co vidí návštěvník webu, i když se v ní někdo přihlásí.
Úprava aplikace#
Klikněte na editovat u aplikace, změňte název, poznámku, limity nebo povolené role a klikněte na Uložit (zpět na přehled) nebo Použít (zůstanete v úpravě). Změny platí hned. Klíče se úpravou aplikace nemění — spravujete je na stránce Klíče. Smažete-li hodnotu limitu, vrátí se limit na výchozí.
Vypnutí aplikace#
Klikněte na Vypnout. Všechny klíče aplikace se od té chvíle odmítají — aplikace dostává stejnou chybu, jako kdyby klíč neposlala. Vypnutí je vratné — tlačítkem Zapnout aplikaci zase pustíte a její platné klíče začnou znovu platit. Použijte ho, když potřebujete aplikaci dočasně zastavit, například při podezřelém provozu.
Klíče aplikace#
Aplikace může mít víc klíčů. Každý klíč může mít datum a čas, kdy přestane platit (Platí do). Díky tomu klíč vyměníte bez výpadku: nová verze aplikace dostane nový klíč a stará verze s původním klíčem běží dál, dokud původní klíč nevyprší. Hodí se to hlavně u mobilní aplikace, kde schválení nové verze v obchodě s aplikacemi trvá i několik dní.
Stránku otevřete tlačítkem Klíče v řádku aplikace. U každého klíče vidíte začátek klíče, popisek, kdy byl založen, do kdy platí, kdy byl naposledy použit a stav:
| Stav | Co znamená |
|---|---|
| Platný | klíč platí |
| Vyprší brzy | klíč platí, ale do 7 dní vyprší — ve sloupci Platí do je i počet dní |
| Vypršel | nastalo datum Platí do, aplikace s tímto klíčem dostane chybu (řádek je šedý) |
| Zrušený | klíč jste zrušili, aplikace s ním dostane chybu (řádek je šedý) |
Limity požadavků patří celé aplikaci, ne jednotlivým klíčům — všechny klíče aplikace je sdílejí.
Nový klíč#
- Na stránce Klíče klikněte na Nový klíč.
- Vyplňte Popisek (nepovinný, např. „verze 2.1“ nebo „server partnera“) a případně Platí do. Prázdné Platí do znamená, že klíč platí, dokud ho nezrušíte.
- Klikněte na Uložit. Nový klíč se ukáže jen jednou nahoře na stránce klíčů — uložte si ho stejně jako při založení.
Ostatní klíče aplikace platí dál. Aplikace může mít nejvýš 5 platných klíčů (vypršelé a zrušené se nepočítají). Když jich má pět, tlačítko Nový klíč je neaktivní — nejdřív některý klíč zrušte, nebo počkejte, až vyprší.
Úprava klíče#
Tlačítkem Upravit změníte popisek a datum Platí do. Datum můžete nastavit i klíči, který ho dosud neměl, posunout ho, nebo ho smazat — klíč pak platí, dokud ho nezrušíte. Datum musí být v budoucnu. Změna platí hned. Zrušený klíč upravit nejde.
Výměna klíče bez výpadku#
- Starému klíči nastavte Platí do — datum, do kdy stará verze aplikace ještě poběží.
- Vydejte nový klíč.
- Nasaďte nový klíč do aplikace (u mobilní aplikace novou verzi).
- Po datu Platí do starý klíč smažte.
Zrušení klíče#
Klikněte u klíče na Zrušit a potvrďte Zrušit klíč. Klíč přestane platit hned a zrušení nejde vrátit; ostatní klíče aplikace platí dál. Zrušte klíč, který unikl nebo se ztratil. Pokud má klíč přestat platit až později, nastavte mu raději Platí do.
Smazání klíče#
Vypršelý nebo zrušený klíč smažete tlačítkem Smazat — z přehledu zmizí. Platný klíč smazat nejde, nejdřív ho zrušte.
Zrušení aplikace#
Klikněte na Zrušit a potvrďte Zrušit natrvalo. Všechny klíče aplikace přestanou platit hned.
Zrušení je konečné: zrušenou aplikaci už nejde zapnout, upravit ani jí vydat nový klíč. Aplikace se nemaže — v přehledu zůstane se stavem Zrušená, abyste věděli, že existovala. Pokud ji chcete jen dočasně zastavit, použijte Vypnutí.
Oprávnění#
Obrazovku a všechny akce na ní má jen role Administrátor. Jednotlivé akce mají vlastní oprávnění (zobrazení, založení, úprava včetně zapnutí a vypnutí, zrušení aplikace, stránka klíčů, nový klíč, úprava klíče, zrušení klíče, smazání klíče), takže je jde v části Uživatelé a role přidělit i jinak.