Vytváření a správa API klíčů

Vytvořit klíč pro veřejné API, zvolit jeho oprávnění a platnost, omezit ho podle IP adresy a potom ho zrušit.

API klíč umožňuje vašim nástrojům volat veřejné API Upsellr jménem vaší organizace. Přístup k API je vyhrazen tarifu Enterprise.

Kde najdete klíče

Otevřete nabídku účtu, potom Manage a API & webhooks. V jiném tarifu než Enterprise zobrazuje sekce „Included in the Enterprise plan“ a tlačítko pro změnu tarifu.

Vytvoření klíče

  1. Klikněte na Create API Key.
  2. Dejte mu Name, který říká, k čemu slouží, například název nástroje, který ho používá.
  3. Zvolte Scope preset:
    • Read only: čtení kanálů, produktů, zdrojů, workflow, členů a organizace.
    • Read & Write: vše kromě spouštění workflow.
    • Full access: všechna oprávnění, včetně spouštění workflow.
    • Custom: požadovaná oprávnění zaškrtnete jedno po druhém.
  4. Zvolte Expiration: 7 dní, 30 dní, 90 dní, 1 rok, 3 roky, No expiration nebo vlastní dobu od 1 do 1 095 dní.
  5. Podle potřeby vyplňte Allowed IPs a Allowed User-Agents, oddělené čárkami.
  6. Klikněte na Create Key.

Klíč se zobrazí jen jednou. Než okno zavřete, zkopírujte ho a uložte na bezpečné místo.

Dostupná oprávnění

Prostředek Oprávnění
Kanály Vytvářet, číst, upravovat, mazat
Produkty Vytvářet, číst, upravovat, mazat
Zdroje Číst, nahrávat zdrojové soubory
Workflow Číst, spouštět
Organizace Číst organizaci, číst členy

Zrušení klíče

V seznamu klikněte vedle klíče na Revoke. Každá integrace, která ho používá, okamžitě přestane fungovat. Tato akce je nevratná.

Dobré vědět

  • Klíče vytvářejí a ruší jen vlastníci a administrátoři. Členové je vidí jen pro čtení.
  • Seznam u každého klíče zobrazuje jeho oprávnění, datum vypršení a Last used: klíč, který nebyl nikdy použit, je často klíčem ke zrušení.
  • Spuštění workflow může zasáhnout mnoho produktů a kreditů. Oprávnění ke spouštění dávejte jen integracím, které ho potřebují.
  • Pro každou integraci vytvořte jeden klíč, jen s nezbytnými oprávněními.
  • Ztracený klíč nelze znovu zobrazit: zrušte ho a vytvořte nový.

Nenašli jste odpověď?

Kontaktujte nás