Přeskočit na hlavní obsah

Vývojářské API a webhooky

Vytvářejte API klíče, registrujte koncové body webhooků a kontrolujte protokoly požadavků z Vývojářského centra.

Autor: Sarah Chen

Vývojářské centrum je místo, kde propojíte Exayard s vlastním kódem a nástroji. Otevřete jej z Nastavení a poté Vývojář. Odsud vytváříte API klíče, registrujete koncové body webhooků a procházíte živý protokol každého API požadavku. Na tuto stránku se dostanou pouze správci organizace.

API klíče

API klíč ověřuje požadavky na API Exayardu. Klíče patří vaší organizaci, takže se správný účet vybere automaticky a žádné ID organizace nepředáváte.

Otevřete kartu API klíče v dlaždici Přihlašovací údaje a klikněte na tlačítko +. Dejte klíči Název a poté zvolte jeho Oprávnění. Vyberte Vše, chcete-li udělit každé oprávnění, nebo Konkrétní, chcete-li vybrat jednotlivá oprávnění. Oprávnění se řídí rozdělením na čtení a zápis pro každý zdroj, jako read:projects a write:estimates. Oprávnění admin:org uděluje plný přístup. Zvolte minimum oprávnění, která vaše integrace potřebuje.

Exayard zobrazí celý klíč jednou, hned po jeho vytvoření. Zkopírujte si ho tehdy, protože se už nikdy nezobrazí. Poté se každý klíč objeví se svým názvem, maskovaným náhledem jako ak_••••1234 a datem posledního použití.

Ikonou tužky klíč přejmenujete nebo změníte jeho oprávnění. Ikonou koše ho Zrušíte. Zrušení je trvalé a jakákoli integrace používající tento klíč okamžitě přestane fungovat.

Stejný klíč ověřuje integrace bez kódu. Viz Propojení Exayardu se Zapierem, Propojení Exayardu s Make a Propojení Exayardu s n8n. Pro přístup agentů a AI editorů viz Propojení s Claude a dalšími AI nástroji.

Webhooky

Webhook říká Exayardu, aby upozornil váš server, když se něco stane. Otevřete kartu Webhooky a kliknutím na + přidejte koncový bod. Zadejte URL, která má přijímat doručení, a volitelný Popis.

Zvolte, ke kterým Událostem se přihlásíte. Vyberte Vše, chcete-li přijímat každou událost, nebo Konkrétní, chcete-li vybrat ze seznamu:

Událost

Nastane, když

project.created

Je vytvořen projekt

project.updated

Je projekt změněn

project.archived

Je projekt archivován

assessment.started

Začne posouzení výkazu výměr

assessment.completed

Posouzení skončí

assessment.approved

Je posouzení schváleno

assessment.cancelled

Je posouzení zrušeno

estimate.generated

Je vygenerován rozpočet

bid.generated

Je vygenerována nabídka

file.processed

Nahraný soubor dokončí zpracování

Když vytvoříte koncový bod, Exayard jednou zobrazí podpisový tajný klíč. Zkopírujte si ho tehdy, protože se už nezobrazí.

Zabezpečení doručení webhooků

Každé doručení nese hlavičku Exayard-Signature ve tvaru t=<unix>,v1=<digest>. Exayard sestaví podpis spojením časového razítka a těla požadavku a poté je podepíše pomocí HMAC-SHA256 s tajným klíčem vašeho koncového bodu.

Chcete-li doručení ověřit, znovu vypočítejte podpis se svým tajným klíčem, ověřte, že je časové razítko v rozmezí pěti minut od nynějška, a porovnejte digesty. Neúspěšná doručení se opakují s exponenciálním odstupem po dobu zhruba tří dnů.

Chcete-li koncový bod upravit, klikněte na ikonu tužky. Můžete změnit URL, popis a události a nastavit jeho Stav na Aktivní nebo Pozastaveno. Pozastavené koncové body přestanou přijímat doručení. Stejný dialog má tlačítko Rotovat tajný klíč. Rotace vydá nový tajný klíč a starý okamžitě přestane fungovat, takže před rotací aktualizujte svůj server. Ikona koše smaže koncový bod a ukončí veškerá doručení na něj.

Rychlý start

Dlaždice Rychlý start obsahuje připravený prompt pro AI editor jako 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í, slovník oprávnění a podpisové schéma webhooků, takže AI dokáže sestavit funkční integraci a vyžádá si od vás potřebné údaje.

Dokumentace

Dlaždice Dokumentace odkazuje na úplnou vývojářskou dokumentaci a OpenAPI specifikaci, která popisuje každou cestu a schéma. Propojit MCP otevře nastavení pro propojení AI agentů přímo s Exayardem.

Protokoly

Sekce Protokoly zaznamenává vaše nejnovější API požadavky napříč REST API i MCP. Každý řádek ukazuje metodu, cestu, stav odpovědi a latenci. Vybráním řádku zobrazíte jeho úplné podrobnosti, včetně ID požadavku a těl požadavku a odpovědi. Protokoly použijte k ověření, že volání proběhlo, nebo k ladění selhávající integrace.

Dostali jste odpověď na svou otázku?