Vytvoření API klíče je základním krokem pro jakoukoliv integraci Foxentry REST API. API klíč slouží k autentizaci vašich požadavků a bez něj nebudou služby fungovat. Každý projekt může mít libovolné množství API klíčů, což vám umožňuje například oddělit přístupy pro různé vývojáře nebo testovací a produkční prostředí.

Postup vygenerování klíče

Pro vygenerování nového API klíče postupujte následovně:

1. Přejděte do Nastavení vašeho API projektu.
2. Otevřete záložku API klíče.
3. Klikněte na prázdnou kartu s nápisem Vytvořit API klíč. Otevře se postranní panel s formulářem.

4. V postranním panelu vyplňte potřebné údaje:

• Název API klíče: zvolte jasný název (např. „Produkce – Web“, „Testování – Honza“), abyste v budoucnu věděli, k čemu klíč slouží,
• Expirace: volitelný údaj, který nastavte v případě, že má klíč po určité době přestat fungovat (pro neomezenou platnost nechte pole prázdné),
• Omezit na IP: zadejte konkrétní IP adresy, pokud chcete, aby šlo klíč použít pouze z určitých serverů, čímž výrazně zvýšíte bezpečnost.

5. Klikněte na tlačítko Vytvořit nový klíč. Klíč se okamžitě vygeneruje a zobrazí na kartě.

Správa existujících klíčů

Na kartě každého klíče vidíte přehled o datu vytvoření, nastaveném omezení na IP a případné expiraci. Kliknutím na ikonu tří teček v pravém horním rohu karty se otevře menu s dalšími akcemi:

• Vygenerovat klíč znovu: zneplatní stávající klíč a vygeneruje pro danou kartu klíč nový (použijte v případě podezření na kompromitaci),
• Upravit: umožňuje změnit název klíče, expiraci nebo omezení na IP,
• Smazat: trvale odstraní klíč a jakékoliv volání API s tímto klíčem okamžitě přestane fungovat.

Pořád nevíte? Ozvěte se nám