API gateway

Co je API klíč a k čemu slouží

API klíč slouží k bezpečnému napojení externích nástrojů, agentur nebo vlastních systémů na služby Heureky – funguje podobně jako heslo, které vaše napojení používá místo vás.

API klíč aktuálně umožňuje dva typy přístupu:

• Měření konverzí – stáhnete si data o objednávkách, které k vám přišly z Heureky.
• Aktualizace nabídek – změny u vašich nabídek pošlete Heurece rovnou, bez čekání na stažení XML souboru.

Nový klíč automaticky získá oba tyto přístupy.

Kde API klíče najdete

V administraci přejděte v levém menu na Nastavení → API klíče.

Pokud ještě žádný klíč nemáte, stránka zobrazí prázdný stav „Zatím nemáte žádný API klíč“ s tlačítkem Vytvořit API klíč a odkazem Zobrazit dokumentaci.

Jak vytvořit nový API klíč

1. V sekci Nastavení → API klíče klikněte na tlačítko Vytvořit API klíč.
2. Otevře se panel Vytvořit API klíč. Do pole Název klíče zadejte popisný název, podle kterého klíč později poznáte (např. „PPC agentura“ nebo „Interní reporting“).
3. V sekci Přístupy zkontrolujte, k čemu bude klíč sloužit – Měření konverzí a Aktualizace nabídek. V tuto chvíli klíč získá oba přístupy automaticky.
4. Klikněte na tlačítko Vytvořit API klíč (vpravo dole).
5. Vytvořený klíč si ihned bezpečně uložte – z bezpečnostních důvodů se v plném znění zobrazí pouze jednou a později ten samý již nelze vygenerovat.

Seznam vytvořených API klíčů

V sekci Seznam API klíčů vidíte u každého klíče:

• Název klíče a jeho zamaskovanou podobu (zobrazí se jen posledních pár znaků, např. ••••loQktlNA==),
• Přístupy, které klíč má,
• Datum vzniku klíče,
• Zda je klíč Aktivní,
• Možnost klíč Zneplatnit.

U seznamu klíčů najdete také odkaz Otevřít dokumentaci API – technické detaily, endpointy a příklady použití.

Jak klíč zneplatnit

Pokud klíč už nepoužíváte, nebo máte podezření na jeho zneužití, můžete ho kdykoliv zneplatnit:

1. V seznamu API klíčů klikněte u příslušného klíče na odkaz Zneplatnit.
2. Zobrazí se potvrzovací okno Zneplatnit API klíč, které vás upozorní, že klíč přestane okamžitě fungovat a napojení, která ho používají, nebudou moct načítat data ani pracovat se službami Heureky.

Více klíčů pro jeden účet

Klíčů si můžete vytvořit i několik najednou – například samostatný pro sebe a samostatný pro agenturu, která pro vás spravuje kampaně. Každý klíč lze pojmenovat, sledovat a zneplatnit nezávisle na ostatních, aniž byste ovlivnili zbylá napojení.

Bezpečnostní doporučení

• API klíč nikdy nesdílejte veřejně (např. v kódu na GitHubu, ve veřejných fórech apod.).
• Pro každé napojení (agentura, vlastní systém) vytvořte samostatný klíč – snáze ho pak zneplatníte, aniž byste ovlivnili ostatní integrace.
• Klíč po vytvoření rovnou uložte do správce hesel – Heureka ho v plném znění znovu nezobrazí.
• Nepoužívané klíče pravidelně kontrolujte a zneplatňujte.