Přeskočit na hlavní obsah

Vývojářské aplikace, klíče API a webhooky

Vytvářejte aplikace a klíče API, testujte v sandboxu, odesílejte webhooky, instalujte aplikace jiných firem a procházejte protokoly požadavků a útratu podle klíčů.

Autor: Sarah Chen

Nastavení Vývojář je místo, kde propojíte Exayard s vlastním kódem a s aplikacemi, které vytvářejí jiné firmy. Otevřete Nastavení a poté Vývojář. V nabídce Nastavení tuto položku vidí pouze správci firmy. Člen, který stránku otevře, ji může číst, ale nemůže nic měnit.

Aplikace, klíče API, webhooky a protokoly jsou součástí každého tarifu včetně tarifu Free. Účtuje se pouze práce s AI.

Aplikace

Aplikace je jedna z vašich integrací, například „Acme estimator“ nebo „Noční synchronizace“. Každý klíč API patří k nějaké aplikaci. Sekce Aplikace je na stránce první. Číst ji může každý člen. Aplikace vytvářejí a mění pouze správci.

Klikněte na Nová aplikace a vyplňte Název, Popis, Domovská stránka, E-mail podpory a Oprávnění. Oprávnění jsou pro každý prostředek rozdělena na čtení a zápis, například read:projects a write:estimates. Aplikace nemohou žádat o oprávnění admin:org. Firma může mít až 25 aplikací.

U každé aplikace je uvedeno, kdy byla vytvořena, a její limit požadavků, například „Až 60 požadavků za minutu na firmu a celkem 600“. Nabídka Další akce aplikace obsahuje:

  • Upravit mění podrobnosti a oprávnění aplikace.

  • Webhook nastavuje jedinou adresu, která přijímá události ze všech firem, které si aplikaci nainstalovaly.

  • Smazat aplikaci aplikaci odstraní a zneplatní všechny její klíče. Každá firma, která si ji nainstalovala, ztratí přístup.

Klíče API

Klíč API umožňuje vašemu vlastnímu kódu volat Exayard API. Klíče jsou uloženy v aplikaci, v části Klíče. Klíč funguje ve firmě, které jeho aplikace patří, takže není potřeba předávat žádné ID firmy.

Klíč vytvoříte kliknutím na Nový klíč v aplikaci. Zadejte klíči Název, například „Produkce“. V části Oprávnění zvolte Vše pro všechna oprávnění, která aplikace má, nebo Konkrétní, chcete-li jich vybrat méně. Pokud je klíč určen pro krátkodobou práci, nastavte volitelné datum Vyprší. Klíč funguje do konce daného dne. Klikněte na Vytvořit.

Exayard zobrazí celý klíč pouze jednou. Zkopírujte si jej v tu chvíli, protože už se nikdy znovu nezobrazí. Exayard uchovává pouze zašifrovanou kopii, takže ztracený klíč nelze obnovit. Vytvořte nový a starý zneplatněte.

Klíč začíná exa_live_. Klíč vytvořený v sandboxu začíná exa_test_. Po vytvoření se u klíče zobrazuje jeho název, náhled jako exa_live_...AbCd a údaj Naposledy použito nebo Nikdy nepoužito. Klíč s omezenou platností zobrazuje Vyprší a datum, klíč po skončení platnosti zobrazuje Platnost vypršela.

Aplikace může mít až 25 aktivních klíčů. Klíč s vypršelou platností se do limitu započítává, dokud jej nezneplatníte. Chcete-li klíče vyměnit bez výpadku, vytvořte druhý klíč, převeďte na něj své servery a poté první zneplatněte.

V nabídce Akce klíče můžete klíč Přejmenovat nebo Zneplatnit. Zneplatnění nelze vrátit zpět a klíč přestane fungovat do 30 sekund.

Pokud se klíč objeví na veřejném místě, například ve veřejném repozitáři kódu, Exayard jej zneplatní, pošle e-mail vašim správcům a ponechá jej v seznamu s označením Nalezen na veřejném místě, zneplatněn.

Pokud si vaši aplikaci nainstalovala jiná firma, zobrazuje dialog nového klíče také volbu Platí pro. Výchozí hodnota je Tato firma. Volba Všechny firmy, které ji nainstalovaly vytvoří klíč, který váš server používá v každé z těchto firem. Každé volání pak uvádí svou firmu v hlavičce Exayard-Organization-Id.

Stejné klíče propojují i nástroje bez kódu. Viz Propojení Exayardu se Zapierem, Propojení Exayardu s Make a Propojení Exayardu s n8n. Pro AI asistenty viz Propojení Exa s vaším AI asistentem.

Starší klíče

Klíče vytvořené dříve, než se klíče začaly ukládat v aplikacích, začínají ak_. Fungují dál, ale nové už vytvořit nelze. Zobrazují se v části Starší klíče dole na stránce, a to jen dokud nějaké existují.

Každý správce tam vidí všechny klíče firmy bez ohledu na to, kdo je vytvořil. Klíč, který vytvořil někdo jiný, zobrazuje Vytvořil a jméno dané osoby. Každý také vidí své vlastní osobní klíče. Kliknutím na ikonu koše klíč Zneplatnit. Klíč okamžitě přestane fungovat.

Sandboxy

Sandbox je testovací firma propojená s vaší firmou. Slouží k vývoji a testování integrace, aniž byste zasahovali do svých skutečných projektů. Sekci Sandboxy vidí pouze správci.

Klikněte na Nový sandbox, zadejte Název a klikněte na Vytvořit. Firma může mít až 5 sandboxů. Tlačítko Otevřít vás přepne do sandboxu, který přepínač firem označuje jako Sandbox. Vytvořte v něm aplikaci a klíč jako obvykle. Jeho klíče začínají exa_test_. Pro ostrý provoz vytvořte stejnou aplikaci a klíč ve své skutečné firmě a vyměňte klíč ve svém kódu.

Sandbox se řídí tarifem vaší firmy a za jeho využití platí vaše firma. Nemá vlastní fakturaci ani vlastní měsíční využití AI. Webhooky a integrace fungují stejně jako ve vaší skutečné firmě.

Sandbox neodesílá e-maily se sdílením nabídky ani podepsané kopie lidem mimo sandbox a neposílá žádné textové zprávy. Zobrazují se jako „Neodesláno, protože tato firma je sandbox“. Pozvánky do sandboxu se odesílají jako obvykle.

Výkazy výměr a čtení souborů v sandboxu vracejí výsledky zkopírované z našeho ukázkového projektu, a to bezplatně. Výkaz výměr, jeho stránky a webhook o dokončení výkazu výměr jsou označeny jako ukázky. Rozpočty, nabídky, vyhledávání prvků a chat odpovídají také ukázkami, rovněž bezplatně.

Chcete-li sandbox odstranit, klikněte na jeho řádku na Smazat a poté na Smazat sandbox. Sandbox se uzavře, jeho klíče přestanou fungovat a jeho data se později vymažou.

Webhooky

Webhook dává Exayardu pokyn upozornit váš server, když se ve vaší firmě něco stane. Seznam může číst každý člen. Webhooky přidávají a mění pouze správci.

Klikněte na Vytvořit webhook, zadejte URL, na kterou se mají doručovat zprávy, a volitelně Popis. Zvolte, které Události se mají odesílat. Vyberte Vše pro příjem všech událostí včetně nových, nebo Konkrétní pro výběr ze seznamu. Všechny události a jejich obsah najdete v katalogu událostí webhooků.

Při vytvoření webhooku Exayard jednou zobrazí jeho Podpisový tajný klíč. Zkopírujte si jej v tu chvíli, protože se znovu nezobrazí.

Vše ostatní najdete v nabídce Další akce webhooku:

  • Upravit mění URL, popis a události a nastavuje Stav na Aktivní nebo Pozastaveno. Pozastavený webhook nepřijímá žádná doručení. Dialog obsahuje také Obměnit tajný klíč. Starý tajný klíč okamžitě přestane fungovat, proto nejprve aktualizujte svůj server.

  • Odeslat testovací událost odešle jednu událost zvoleného typu v poli Typ události. Dialog počká na odpověď vašeho serveru a zobrazí výsledek a kód odpovědi. Testovací událost obsahuje "test": true.

  • Doručení uvádí posledních 25 doručení s jejich událostí, stavem, kódem odpovědi a počtem pokusů. Doručení je ve stavu Čeká, Opakování, Doručeno nebo Selhalo. Správci mohou kliknutím na Odeslat znovu doručení odeslat ještě jednou.

  • Smazat webhook ukončí všechna doručení na danou URL.

Testovací událost a opakované odeslání se odesílají jednou a nikdy se neopakují.

Zabezpečení doručování webhooků

Každé doručení obsahuje hlavičku Exayard-Signature ve tvaru t=<unix>,v1=<digest>. Exayard vytváří podpis spojením časového razítka a těla požadavku a jejich podepsáním algoritmem HMAC-SHA256 pomocí tajného klíče vašeho webhooku.

Každé doručení dále obsahuje hlavičky Exayard-Event-Id, Exayard-Event-Type a Exayard-Organization-Id. Tělo JSON obsahuje pole organizationId, které určuje firmu, z níž událost pochází. Hlavička nese stejné ID, takže doručení můžete směrovat ještě před přečtením těla. Podpis pokrývá celé tělo včetně organizationId.

Protože každé doručení uvádí svou firmu, může jedna přijímací adresa obsluhovat mnoho firem. Zaregistrujte stejnou URL v každé firmě a každé doručení směrujte podle organizationId. Každý webhook má vlastní tajný klíč, proto před ověřením vyberte tajný klíč podle Exayard-Organization-Id.

Chcete-li doručení ověřit, přepočítejte podpis pomocí svého tajného klíče, ověřte, že se časové razítko neliší od aktuálního času o více než pět minut, a porovnejte otisky.

Neúspěšné doručení se zkouší celkem až 10krát po dobu zhruba 80 hodin, s prodlužujícími se intervaly mezi pokusy. Každý pokus odesílá stejné tělo a stejné ID události. Přesměrování se počítá jako selhání.

Povolení instalace vaší aplikace jiným firmám

Vaše aplikace funguje ve vaší vlastní firmě hned po vytvoření. Každá aplikace má také část Povolit instalaci této aplikace jiným firmám. Ukazuje, zda je aplikace ve stavu Zkontrolováno, Kontrola vyžádána nebo Nezkontrolováno, její Přihlašovací adresy, její ID klienta a kolik firem si ji může nainstalovat.

Správci k tomu otevírají nabídku Akce instalace:

  • Upravit přihlašovací adresy nastavuje adresy, na které Exayard vrací uživatele, když je vaše aplikace přihlašuje jejich účtem Exayard. Zadejte jednu adresu na řádek, nejvýše 10. Každá musí začínat https://, nebo během testování http://localhost. Když poprvé uložíte přihlašovací adresy, Exayard jednou zobrazí Tajný klíč klienta aplikace.

  • Kopírovat odkaz pro instalaci zkopíruje odkaz, který můžete poslat kterékoli firmě. Správci dané firmy otevře dialog instalace.

  • Požádat o kontrolu odešle aplikaci ke kontrole podpoře Exayardu.

Novou aplikaci lze nainstalovat až do 25 firem kromě vaší vlastní a nezobrazuje se v sekci Najít aplikace. Firmy v části Účty pro vaše zákazníky se do tohoto limitu nezapočítávají. Po schválení se u aplikace zobrazí Zkontrolováno a limit instalací se zruší. Pomocí Zobrazit v sekci Najít aplikace ji zařadíte do adresáře každé firmy, pomocí Skrýt ze sekce Najít aplikace ji z něj odeberete. Aplikace ve stavu Pozastaveno nemůže volat Exayard, dokud podpora pozastavení nezruší, a její instalace zůstávají zachovány.

Když aplikaci oprávnění odeberete, všechny instalace o ně okamžitě přijdou. Když oprávnění přidáte, každá firma si ponechá svůj stávající přístup, dokud nová oprávnění neschválí některý z jejích správců.

Webhook aplikace

Otevřete nabídku Další akce aplikace a klikněte na Webhook. Zadejte URL a klikněte na Vytvořit, poté zkopírujte Podpisový tajný klíč, který Exayard zobrazí pouze jednou. Každá firma, která si aplikaci nainstalovala, odesílá události, na které se vztahují udělená oprávnění. Vaše aplikace navíc přijímá app.installed, app.scopes_approved a app.uninstalled, když si ji firma nainstaluje, schválí širší přístup nebo ji odebere. Doručení uvádějí svou firmu a jsou podepsána stejně jako ostatní webhooky.

Ve stejném dialogu můžete doručování Pozastavit a Obnovit, použít Obměnit tajný klíč a Smazat webhook.

Připojené aplikace

Sekce Připojené aplikace uvádí aplikace nainstalované ve vaší firmě. Vidí ji každý člen. Instalovat, odebírat a schvalovat mohou pouze správci.

Každý řádek uvádí název aplikace, zda je Zkontrolováno, firmu, která ji vytvořila, kdo a kdy ji nainstaloval a udělená oprávnění.

Instalace aplikace

Otevřete odkaz pro instalaci aplikace, nebo u ní v sekci Najít aplikace klikněte na Nainstalovat. Dialog ukazuje, kdo aplikaci vytvořil, zda je zkontrolovaná, a oprávnění, o která žádá. Poté zvolte:

  • Firma: kterákoli firma, ve které jste správcem. Firma, která už aplikaci má, je označena (nainstalováno). Opětovnou instalací uložíte své nové volby.

  • Projekty: Všechny projekty, nebo Pouze tyto projekty a zaškrtněte ty, ke kterým má aplikace přístup, nejvýše 500. K žádnému jinému projektu ve firmě se aplikace nedostane.

  • Měsíční limit AI: nejvyšší částka, kterou smí práce s AI této aplikace stát vaši firmu za každý fakturační měsíc, ve vaší fakturační měně. Ponecháte-li pole prázdné, platí Bez limitu.

Klikněte na Nainstalovat. Pokud vás aplikace přihlašuje, Exayard vás poté provede dokončením přihlášení do aplikace. Pokud jste člen, ale ne správce, dialog vám sdělí, správce které firmy ji může nainstalovat. Kliknutím na Kopírovat odkaz mu jej pošlete.

Chcete-li později změnit projekty, otevřete odkaz pro instalaci znovu a nainstalujte aplikaci s novou volbou.

Schválení širšího přístupu

Když aplikace žádá o další oprávnění, její řádek zobrazuje Žádá o širší přístup spolu s novými oprávněními. Správce je udělí kliknutím na Schválit. Do té doby si aplikace ponechá přístup, který měla.

Odebrání aplikace

Otevřete nabídku Další akce aplikace, klikněte na Odebrat a potvrďte. Aplikace okamžitě ztratí přístup k vaší firmě a její webhooky se zastaví. Práce s AI, kterou už spustila, se přesto dokončí.

Najít aplikace

Sekce Najít aplikace se nachází v sekci Připojené aplikace. Uvádí zkontrolované aplikace, které se jejich tvůrci rozhodli zveřejnit. Aplikace, kterou už vaše firma má, zobrazuje Nainstalováno. Kliknutím na Nainstalovat u kterékoli jiné aplikace otevřete dialog instalace.

Vaše osobní připojení

Sekce Vaše osobní připojení uvádí nástroje AI a další aplikace, které jste připojili ke svému vlastnímu účtu Exayard, například ChatGPT nebo Claude. Zobrazuje se nahoře v sekci Připojené aplikace a svá připojení vidíte pouze vy. Osobní připojení jedná vaším jménem, takže se dostane ke všemu, k čemu vy.

U každého připojení je uvedeno, kdy bylo poprvé a naposledy použito, a firmy, ve kterých bylo použito. Chcete-li některé zastavit, otevřete jeho nabídku Další akce, klikněte na Odebrat a potvrďte. Jeho další volání bude odmítnuto. Připojení zůstane v seznamu s označením Odebráno a pomocí Znovu povolit jej opět vpustíte. Postup připojení nového nástroje popisuje článek Propojení Exa s vaším AI asistentem.

Účty pro vaše zákazníky

Vaše aplikace může prostřednictvím API vytvářet firmy v Exayardu pro zákazníky, kteří Exayard používají pouze přes váš produkt. Tyto firmy vlastní vaše firma a platí za práci s AI, která v nich probíhá. Nemají žádné vlastní členy a vaše aplikace se do nich instalují automaticky.

Sekce Účty pro vaše zákazníky je správcům uvádí s údajem Název každé firmy a datem v poli Vytvořeno. Firmu uzavřete kliknutím na Vzdát se a potvrzením. Každá aplikace v ní ztratí přístup.

Začínáme

Karta Rychlý start obsahuje připravený prompt pro AI editor, jako je Claude nebo Cursor. Klikněte na Kopírovat prompt a vložte jej do svého editoru. Prompt obsahuje základní URL API, formát ověřování, oprávnění a schéma podepisování webhooků, takže AI dokáže připravit funkční integraci a vyžádat si od vás potřebné podrobnosti. Tuto kartu vidí pouze správci, protože vyžaduje klíč API.

Karta Dokumentace odkazuje tlačítkem Otevřít dokumentaci na úplnou dokumentaci pro vývojáře a na Specifikace OpenAPI, která popisuje všechny cesty a schémata. Správci navíc vidí Připojit ke Claude nebo Cursoru, které otevře nastavení pro připojení AI asistentů k Exayardu.

Protokoly

Sekce Protokoly zobrazuje požadavky na API, od nejnovějších. Každý řádek uvádí Metoda, Cesta, Stav, Čas a Latence. Starší požadavky zobrazíte kliknutím na Načíst další dole.

Správci vidí všechny požadavky. Členové vidí pouze požadavky, které nepřišly přes aplikaci.

Správci mohou filtrovat podle pole Aplikace a poté podle jednoho z klíčů dané aplikace. Kdokoli může zadat Koncový uživatel a zobrazit pouze požadavky daného zákazníka. Koncový uživatel je vaše vlastní ID pro jednoho z vašich zákazníků. Váš kód jej posílá s každým požadavkem v hlavičce Exayard-End-User. Jako ID nikdy nepoužívejte e-mailovou adresu.

Výběrem řádku zobrazíte jeho úplné podrobnosti včetně ID požadavku, aplikace a koncového uživatele a také Tělo požadavku a Tělo odpovědi. Protokoly využijete k ověření, že volání proběhlo úspěšně, nebo ke zjištění, proč integrace selhává.

Útrata podle klíčů a koncových uživatelů

Správci vidí, kolik každá aplikace tento měsíc utratila, v části Útrata podle aplikací v Nastavení a poté Využití. Uvedeny jsou tam i vaše vlastní aplikace. U každé aplikace ukazuje Podle klíče, kolik utratil každý klíč, a Největší koncoví uživatelé ukazuje pět koncových uživatelů, kteří utratili nejvíce. Útrata, která nepatří k žádnému z klíčů aplikace, se zobrazuje jako Jiné.

Měsíční limit AI

Měsíční limit AI aplikace je nejvyšší částka, kterou smí práce s AI této aplikace stát vaši firmu za každý fakturační měsíc. Chcete-li jej nastavit, otevřete nabídku Další akce aplikace v části Útrata podle aplikací a klikněte na Nastavit měsíční limit AI. Zadejte částku ve své fakturační měně a klikněte na Uložit. Uložením prázdného pole limit odeberete.

Když aplikace dosáhne svého limitu, její práce s AI se po zbytek fakturačního měsíce odmítá, i když vaší firmě ještě zbývá využití AI. Vlastní limity vaší firmy platí i nadále. Práce s AI, kterou spustí sami lidé, se do limitu aplikace nikdy nezapočítává.

Dostali jste odpověď na svou otázku?