API gateway

Čo je API kľúč a na čo slúži

API kľúč slúži na bezpečné napojenie externých nástrojov, agentúr alebo vlastných systémov na služby Heureky – funguje podobne ako heslo, ktoré vaše napojenie používa namiesto vás.

API kľúč aktuálne umožňuje dva typy prístupu:

• Meranie konverzií – stiahnete si údaje o objednávkach, ktoré k vám prišli z Heureky.
• Aktualizácia ponúk – zmeny vo vašich ponukách odošlete Heureke priamo, bez čakania na stiahnutie XML súboru.

Nový kľúč automaticky získa oba tieto prístupy.

Kde nájdete API kľúče

V administrácii prejdite v ľavom menu na Nastavenia → API kľúče.

Ak ešte žiadny kľúč nemáte, stránka zobrazí prázdny stav „Zatiaľ nemáte žiadny API kľúč“ s tlačidlom Vytvoriť API kľúč a odkazom Zobraziť dokumentáciu.

Ako vytvoriť nový API kľúč

1. V sekcii Nastavenia → API kľúče kliknite na tlačidlo Vytvoriť API kľúč.
2. Otvorí sa panel Vytvoriť API kľúč. Do poľa Názov kľúča zadajte popisný názov, podľa ktorého kľúč neskôr poznáte (napr. „PPC agentúra“ alebo „Interný reporting“).
3. V sekcii Prístupy skontrolujte, na čo bude kľúč slúžiť – Meranie konverzií a Aktualizácia ponúk. V tejto chvíli kľúč získa oba prístupy automaticky.
4. Kliknite na tlačidlo Vytvoriť API kľúč (vpravo dole).
5. Vytvorený kľúč si hneď bezpečne uložte – z bezpečnostných dôvodov sa v plnom znení zobrazí iba jedenkrát a neskôr ten istý už nemožno vygenerovať.

Zoznam vytvorených API kľúčov

V sekcii Zoznam API kľúčov vidíte pri každom kľúči:

• Názov kľúča a jeho zamaskovanú podobu (zobrazí sa len posledných pár znakov, napr. ••••loQktlNA==),
• Prístupy, ktoré kľúč má,
• Dátum vzniku kľúča,
• Či je kľúč Aktívny,
• Možnosť kľúč Zneplatniť.

V zozname kľúčov nájdete aj odkaz Otvoriť dokumentáciu API – technické detaily, endpointy a príklady použitia.

Ako kľúč zneplatniť

Ak kľúč už nepoužívate, alebo máte podozrenie na jeho zneužitie, môžete ho kedykoľvek zneplatniť:

1. V zozname API kľúčov kliknite pri príslušnom kľúči na odkaz Zneplatniť.
2. Zobrazí sa potvrdzovacie okno Zneplatniť API kľúč, ktoré vás upozorní, že kľúč prestane okamžite fungovať a napojenia, ktoré ho používajú, nebudú môcť načítať dáta ani pracovať so službami Heureky.

Viac kľúčov pre jeden účet

Kľúčov si môžete vytvoriť aj niekoľko naraz – napríklad samostatný pre seba a samostatný pre agentúru, ktorá pre vás spravuje kampane. Každý kľúč je možné pomenovať, sledovať a zneplatniť nezávisle od ostatných, bez toho aby ste ovplyvnili zostávajúce napojenia.

Bezpečnostné odporúčania

• API kľúč nikdy nezdieľajte verejne (napr. v kóde na GitHube, na verejných fórach a pod.).
• Pre každé napojenie (agentúra, vlastný systém) vytvorte samostatný kľúč – ľahšie ho potom zneplatníte, bez toho aby ste ovplyvnili ostatné integrácie.
• Kľúč po vytvorení hneď uložte do správcu hesiel – Heureka ho v plnom znení znova nezobrazí.
• Nepoužívané kľúče pravidelne kontrolujte a zneplatňujte.