Ugrás a fő tartalomra

Fejlesztői API és webhookok

Hozzon létre API-kulcsokat, regisztráljon webhook-végpontokat, és tekintse át a kéréseket a Fejlesztői központból.

Írta: Sarah Chen

A Fejlesztői központ az a hely, ahol az Exayardot a saját kódjához és eszközeihez csatlakoztatja. Nyissa meg a Beállítások, majd a Fejlesztő menüpontból. Innen API-kulcsokat hoz létre, webhook-végpontokat regisztrál, és áttekinti minden API-kérés élő naplóját. Csak a szervezeti adminisztrátorok érhetik el ezt az oldalt.

API-kulcsok

Egy API-kulcs hitelesíti az Exayard API-hoz intézett kéréseket. A kulcsok a szervezetéhez tartoznak, így automatikusan a megfelelő fiók van kiválasztva, és nincs szervezetazonosító, amit át kellene adni.

Nyissa meg az API keys lapot a Credentials kártyán, és kattintson a + gombra. Adjon a kulcsnak egy Name-et, majd válassza ki a Scopes-ait. Válassza az All lehetőséget minden hatókör megadásához, vagy a Specific lehetőséget egyes jogosultságok kiválasztásához. A hatókörök erőforrásonként olvasás-írás felosztást követnek, mint például read:projects és write:estimates. Az admin:org hatókör teljes hozzáférést biztosít. Válassza ki a minimális hatóköröket, amelyekre az integrációjának szüksége van.

Az Exayard egyszer mutatja meg a teljes kulcsot, közvetlenül a létrehozása után. Másolja ki akkor, mert többé nem jelenik meg. Ezután minden kulcs a nevével, egy maszkolt előnézettel, például ak_••••1234, és az utolsó használat dátumával jelenik meg.

Használja a ceruza ikont egy kulcs átnevezéséhez vagy a hatóköreinek módosításához. Használja a kuka ikont a Revoke művelethez. A visszavonás végleges, és az adott kulcsot használó bármely integráció azonnal leáll.

Ugyanez a kulcs hitelesíti a kód nélküli integrációkat. Lásd: Az Exayard csatlakoztatása a Zapierhez, Az Exayard csatlakoztatása a Make-hez és Az Exayard csatlakoztatása az n8n-hez. Az ügynöki és AI-szerkesztői hozzáféréshez lásd: Csatlakozás a Claude-hoz és más AI-eszközökhöz.

Webhookok

Egy webhook arra utasítja az Exayardot, hogy értesítse a szerverét, amikor valami történik. Nyissa meg a Webhooks lapot, és kattintson a + gombra egy végpont hozzáadásához. Adja meg az URL-t, amelynek fogadnia kell a kézbesítéseket, és egy opcionális Description-t.

Válassza ki, mely Events-ekre szeretne feliratkozni. Válassza az All lehetőséget minden esemény fogadásához, vagy a Specific lehetőséget a listából való választáshoz:

Esemény

Kiváltja, amikor

project.created

Egy projekt létrejön

project.updated

Egy projekt módosul

project.archived

Egy projekt archiválódik

assessment.started

Egy felmérési értékelés elindul

assessment.completed

Egy értékelés befejeződik

assessment.approved

Egy értékelést jóváhagynak

assessment.cancelled

Egy értékelést visszavonnak

estimate.generated

Egy árkalkuláció generálódik

bid.generated

Egy árajánlat generálódik

file.processed

Egy feltöltött fájl feldolgozása befejeződik

Amikor létrehoz egy végpontot, az Exayard egyszer mutat egy signing secret-et. Másolja ki akkor, mert többé nem jelenik meg.

A webhook-kézbesítések biztonsága

Minden kézbesítés egy Exayard-Signature fejlécet hordoz a t=<unix>,v1=<digest> formában. Az Exayard úgy építi fel az aláírást, hogy összekapcsolja az időbélyeget és a kérés törzsét, majd HMAC-SHA256-tal aláírja őket a végpont titkos kulcsával.

Egy kézbesítés ellenőrzéséhez számítsa ki újra az aláírást a titkos kulcsával, erősítse meg, hogy az időbélyeg az aktuálistól számítva öt percen belül van, és hasonlítsa össze a kivonatokat. A sikertelen kézbesítések exponenciális visszalépéssel, nagyjából három napon át próbálkoznak újra.

Egy végpont szerkesztéséhez kattintson a ceruza ikonra. Módosíthatja az URL-t, a leírást és az eseményeket, és beállíthatja a Status-át Active vagy Paused értékre. A szüneteltetett végpontok nem kapnak kézbesítéseket. Ugyanabban a párbeszédablakban van egy Rotate secret gomb. A forgatás új titkos kulcsot ad ki, és a régi azonnal leáll, ezért frissítse a szerverét, mielőtt forgatna. A kuka ikon törli a végpontot, és megszünteti az összes kézbesítést hozzá.

Gyors kezdés

A Quick start kártya egy kész promptot tartalmaz egy AI-szerkesztőhöz, mint a Claude vagy a Cursor. Kattintson a Copy prompt gombra, és illessze be a szerkesztőjébe. A prompt tartalmazza az API alap-URL-jét, a hitelesítési formátumot, a hatókör-szókészletet és a webhook-aláírási sémát, így az AI felvázolhat egy működő integrációt, és bekéri Öntől a szükséges részleteket.

Dokumentáció

A Documentation kártya a teljes fejlesztői dokumentációra és az OpenAPI spec-re hivatkozik, amely leírja az összes útvonalat és sémát. A Connect MCP megnyitja az AI-ügynökök közvetlenül az Exayardhoz való csatlakoztatásának beállítását.

Naplók

A Logs szakasz rögzíti a legutóbbi API-kéréseit mind a REST API-n, mind az MCP-n keresztül. Minden sor megmutatja a metódust, az útvonalat, a válasz állapotát és a késleltetést. Válasszon ki egy sort a teljes részleteinek megtekintéséhez, beleértve a kérésazonosítót, valamint a kérés és válasz törzsét. Használja a naplókat annak megerősítésére, hogy egy hívás működött, vagy egy hibás integráció hibakereséséhez.

Választ kapott a kérdésére?