A Fejlesztő beállításoknál kapcsolhatja össze az Exayardot a saját kódjával és a más cégek által készített alkalmazásokkal. Nyissa meg a Beállítások, majd a Fejlesztő menüpontot. A Beállítások menüben csak a cég adminisztrátorai látják. Ha egy tag megnyitja az oldalt, megtekintheti, de semmit sem módosíthat.
Az alkalmazások, az API-kulcsok, a webhookok és a naplók minden csomagban elérhetők, az ingyenes csomagban is. Csak az AI-munkáért kell fizetni.
Alkalmazások
Az alkalmazás az Ön egyik integrációja, például „Acme estimator” vagy „Nightly sync”. Minden API-kulcs egy alkalmazáshoz tartozik. Az oldal első része az Alkalmazások. Ezt minden tag megtekintheti. Alkalmazást létrehozni vagy módosítani csak az adminisztrátorok tudnak.
Kattintson az Új alkalmazás gombra, és töltse ki a Név, Leírás, Kezdőlap, Támogatási e-mail-cím és Hatókörök mezőket. A hatókörök erőforrásonként olvasási és írási jogra oszlanak, például read:projects és write:estimates. Az alkalmazások nem kérhetik az admin:org hatókört. Egy cégnek legfeljebb 25 alkalmazása lehet.
Minden alkalmazásnál látható, mikor hozták létre, és mekkora a kérési korlátja, például „Cégenként legfeljebb 60 kérés percenként, összesen 600”. Az alkalmazás További műveletek menüje a következőket tartalmazza:
A Szerkesztés módosítja az alkalmazás adatait és hatóköreit.
A Webhook azt az egyetlen címet állítja be, amely az alkalmazást telepítő összes cégtől fogadja az eseményeket.
Az Alkalmazás törlése eltávolítja az alkalmazást, és visszavonja az összes kulcsát. Minden cég, amely telepítette, elveszíti a hozzáférését.
API-kulcsok
Az API-kulcs segítségével a saját kódja meghívhatja az Exayard API-t. A kulcsok egy alkalmazáson belül, a Kulcsok részben találhatók. A kulcs az alkalmazása saját cégében működik, így nem kell cégazonosítót megadnia.
Kulcs létrehozásához kattintson az alkalmazásban az Új kulcs gombra. Adjon meg egy nevet a kulcsnak a Név mezőben, például „Production”. A Hatókörök résznél az Összes lehetőséggel az alkalmazás minden hatókörét megadja, a Kiválasztott lehetőséggel pedig kevesebbet választhat. Ha a kulcs rövid távú munkához kell, megadhat egy Lejárat dátumot. A kulcs az adott nap végéig működik. Kattintson a Létrehozás gombra.
Az Exayard a teljes kulcsot csak egyszer jeleníti meg. Ekkor másolja ki, mert később már soha nem látható. Az Exayard csak egy titkosított másolatot őriz, így az elveszett kulcs nem állítható helyre. Ilyenkor hozzon létre egy újat, és vonja vissza a régit.
A kulcs exa_live_ előtaggal kezdődik. A tesztkörnyezetben létrehozott kulcs exa_test_ előtaggal kezdődik. Létrehozás után a kulcsnál megjelenik a neve, egy előnézet, például exa_live_...AbCd, valamint az Utoljára használva időpont vagy a Soha nem használt felirat. A lejárattal rendelkező kulcsnál a Lejárat felirat és a dátum látható, a lejárt kulcsnál pedig a Lejárt felirat.
Egy alkalmazásnak legfeljebb 25 aktív kulcsa lehet. A lejárt kulcs is beleszámít, amíg vissza nem vonja. A kiesés nélküli kulcsváltáshoz hozzon létre egy második kulcsot, állítsa át rá a szervereit, majd vonja vissza az elsőt.
A kulcs Kulcsműveletek menüjében átnevezheti (Átnevezés) vagy visszavonhatja (Visszavonás) a kulcsot. A visszavonás nem vonható vissza, és a kulcs 30 másodpercen belül leáll.
Ha egy kulcs nyilvános helyen bukkan fel, például egy nyilvános kódtárban, az Exayard visszavonja, e-mailt küld az adminisztrátorainak, és a kulcsot Nyilvános helyen előkerült, visszavonva jelöléssel a listában hagyja.
Ha egy másik cég telepítette az alkalmazását, az új kulcs párbeszédablakában a Hol használható beállítás is megjelenik. Az alapértelmezés az Ez a cég. A Minden cég, amely telepítette lehetőséggel olyan kulcsot hoz létre, amelyet a szervere mindegyik ilyen cégben használhat. Ilyenkor minden hívás az Exayard-Organization-Id fejlécben nevezi meg a céget.
Ugyanezek a kulcsok kapcsolják össze a kódolás nélküli eszközöket is. Lásd: Az Exayard összekapcsolása a Zapierrel, Az Exayard összekapcsolása a Make-kel és Az Exayard összekapcsolása az n8n-nel. Az AI-asszisztensekről lásd: Az Exa összekapcsolása az AI-asszisztensével.
Régi kulcsok
Azok a kulcsok, amelyek még azelőtt készültek, hogy a kulcsok alkalmazásokhoz tartoztak volna, ak_ előtaggal kezdődnek. Továbbra is működnek, de újakat már nem lehet létrehozni. Az oldal alján, a Régi kulcsok részben jelennek meg, de csak addig, amíg van ilyen kulcs.
Ott minden adminisztrátor a cég összes kulcsát látja, bárki hozta is létre őket. A más által létrehozott kulcsnál a Létrehozta felirat és az illető neve látható. Mindenki a saját személyes kulcsait is látja. A kulcs visszavonásához (Visszavonás) kattintson a kuka ikonra. A kulcs azonnal leáll.
Tesztkörnyezetek
A tesztkörnyezet egy az Ön cégéhez kapcsolt tesztcég. Ebben úgy építhet és tesztelhet integrációt, hogy a valódi projektjeihez nem nyúl. A Tesztkörnyezetek részt csak az adminisztrátorok látják.
Kattintson az Új tesztkörnyezet gombra, adjon meg egy nevet a Név mezőben, majd kattintson a Létrehozás gombra. Egy cégnek legfeljebb 5 tesztkörnyezete lehet. A Megnyitás átvált a tesztkörnyezetbe, ahol a cégváltó Tesztkörnyezet jelöléssel mutatja. Itt a szokásos módon hozhat létre alkalmazást és kulcsot. A kulcsai exa_test_ előtaggal kezdődnek. Az éles használathoz hozza létre ugyanazt az alkalmazást és kulcsot a valódi cégében, és cserélje le a kulcsot a kódjában.
A tesztkörnyezet a cége csomagját követi, a használatáért pedig a cége fizet. Nincs saját számlázása, és nem kap saját havi AI-használatot. A webhookok és az integrációk ugyanúgy működnek, mint a valódi cégében.
A tesztkörnyezet nem küld ajánlatmegosztó e-maileket és aláírt példányokat a tesztkörnyezeten kívüli személyeknek, és SMS-t sem küld. Ezeknél a „Nincs elküldve, mert ez a cég tesztkörnyezet” felirat jelenik meg. A tesztkörnyezethez való csatlakozásra szóló meghívókat a rendszer a szokásos módon elküldi.
A tesztkörnyezetben a mennyiségszámítások és a fájlbeolvasások díjmentesen a mintaprojektünkből másolt eredményeket adnak vissza. A mennyiségszámítás, annak oldalai és a mennyiségszámítás befejezéséről szóló webhook mintaként van megjelölve. A költségvetések, az ajánlatok, az elemkeresés és a csevegés is díjmentesen, mintákkal válaszol.
Tesztkörnyezet eltávolításához kattintson a sorában a Törlés gombra, majd a Tesztkörnyezet törlése gombra. A tesztkörnyezet bezárul, a kulcsai leállnak, az adatait pedig a rendszer később törli.
Webhookok
A webhook révén az Exayard értesíti a szerverét, amikor valami történik a cégében. A listát minden tag megtekintheti. Webhookot hozzáadni vagy módosítani csak az adminisztrátorok tudnak.
Kattintson a Webhook létrehozása gombra, adja meg a kézbesítéseket fogadó címet az URL mezőben, és opcionálisan töltse ki a Leírás mezőt. Válassza ki, mely Események kerüljenek elküldésre. Az Összes lehetőséggel minden eseményt megkap, az újakat is, a Kiválasztott lehetőséggel pedig a listából választhat. Minden esemény és annak tartalma megtalálható a webhookesemények katalógusában.
Webhook létrehozásakor az Exayard egyszer megjeleníti az Aláírási titkos kulcs értékét. Ekkor másolja ki, mert később már nem látható.
A webhook További műveletek menüjében a többi lehetőség is elérhető:
A Szerkesztés módosítja az URL-címet, a leírást és az eseményeket, és az Állapot mezőt Aktív vagy Szüneteltetve értékre állítja. A szüneteltetett webhook nem kap kézbesítéseket. A párbeszédablakban a Titkos kulcs cseréje gomb is megtalálható. A régi titkos kulcs azonnal érvényét veszti, ezért előbb frissítse a szerverét.
A Tesztesemény küldése egy eseményt küld a kiválasztott Eseménytípus szerint. A párbeszédablak megvárja a szervere válaszát, és megjeleníti az eredményt és a válaszkódot. A tesztesemény tartalmazza a
"test": trueértéket.A Kézbesítések az utolsó 25 kézbesítést sorolja fel az eseménnyel, az állapottal, a válaszkóddal és a próbálkozások számával. Egy kézbesítés állapota lehet Függőben, Újrapróbálkozás, Kézbesítve vagy Sikertelen. Az adminisztrátorok az Újraküldés gombbal újra elküldhetik a kézbesítést.
A Webhook törlése az adott URL-címre irányuló összes kézbesítést leállítja.
A teszteseményt és az újraküldést a rendszer egyszer küldi el, és soha nem próbálja újra.
A webhook-kézbesítések védelme
Minden kézbesítés tartalmaz egy Exayard-Signature fejlécet t=<unix>,v1=<digest> formában. Az Exayard úgy állítja elő az aláírást, hogy összefűzi az időbélyeget és a kérés törzsét, majd a webhook titkos kulcsával HMAC-SHA256 algoritmussal aláírja őket.
Minden kézbesítés tartalmazza az Exayard-Event-Id, az Exayard-Event-Type és az Exayard-Organization-Id fejlécet is. A JSON-törzs organizationId mezője megnevezi azt a céget, amelytől az esemény származik. A fejléc ugyanezt az azonosítót tartalmazza, így a kézbesítést még a törzs beolvasása előtt továbbíthatja a megfelelő helyre. Az aláírás a teljes törzsre kiterjed, az organizationId mezőt is beleértve.
Mivel minden kézbesítés megnevezi a cégét, egyetlen fogadócím több céget is kiszolgálhat. Regisztrálja ugyanazt az URL-címet minden cégnél, és az organizationId alapján irányítsa a kézbesítéseket. Minden webhooknak saját titkos kulcsa van, ezért az ellenőrzés előtt az Exayard-Organization-Id alapján válassza ki a megfelelő kulcsot.
Egy kézbesítés ellenőrzéséhez számítsa ki újra az aláírást a titkos kulccsal, győződjön meg róla, hogy az időbélyeg legfeljebb öt perccel tér el a jelenlegi időtől, majd hasonlítsa össze a kivonatokat.
A sikertelen kézbesítést a rendszer összesen legfeljebb 10 alkalommal próbálja meg, nagyjából 80 óra alatt, egyre hosszabb szünetekkel a próbálkozások között. Minden próbálkozás ugyanazt a törzset és ugyanazt az eseményazonosítót küldi. Az átirányítás sikertelennek számít.
Telepítés engedélyezése más cégeknek
Az alkalmazása a létrehozás pillanatától működik a saját cégében. Minden alkalmazásnak van egy Telepítés engedélyezése más cégeknek része is. Ez megmutatja, hogy az alkalmazás állapota Ellenőrizve, Ellenőrzés kérve vagy Nincs ellenőrizve, valamint a Bejelentkezési címek és az Ügyfél-azonosító értékét, és azt, hogy hány cég telepítheti.
Az adminisztrátorok a Telepítési műveletek menüben a következőket érik el:
A Bejelentkezési címek szerkesztése azokat a címeket állítja be, ahová az Exayard visszairányítja a felhasználókat, amikor az alkalmazása az Exayard-fiókjukkal jelentkezteti be őket. Soronként egy címet adjon meg, legfeljebb 10-et. Mindegyiknek
https://előtaggal kell kezdődnie, teszteléskor pedighttp://localhostelőtaggal. Amikor először menti a bejelentkezési címeket, az Exayard egyszer megjeleníti az alkalmazás Titkos ügyfélkulcs értékét.A Telepítési link másolása egy olyan linket másol ki, amelyet bármely cégnek elküldhet. A link megnyitja a telepítési párbeszédablakot az adott cég adminisztrátora számára.
Az Ellenőrzés kérése ellenőrzésre küldi az alkalmazást az Exayard ügyfélszolgálatának.
Az új alkalmazás a saját cégén kívül legfeljebb 25 cégben telepíthető, és nem jelenik meg az Alkalmazáskereső listájában. A Fiókok az ügyfelei számára részben szereplő cégek nem számítanak bele ebbe a korlátba. Jóváhagyás után az alkalmazás állapota Ellenőrizve, és a telepítési korlát megszűnik. A Megjelenítés az Alkalmazáskeresőben elemmel minden cég könyvtárában megjelenítheti, az Elrejtés az Alkalmazáskeresőből elemmel pedig eltávolíthatja onnan. A Felfüggesztve állapotú alkalmazás nem hívhatja az Exayardot, amíg az ügyfélszolgálat fel nem oldja a felfüggesztést, a telepítései azonban megmaradnak.
Ha hatóköröket távolít el egy alkalmazásból, azokat minden telepítés azonnal elveszíti. Ha hatóköröket ad hozzá, minden cég megtartja a jelenlegi hozzáférését, amíg valamelyik adminisztrátora jóvá nem hagyja az új hatóköröket.
Az alkalmazás webhookja
Nyissa meg az alkalmazás További műveletek menüjét, és kattintson a Webhook elemre. Adja meg az URL címet, kattintson a Létrehozás gombra, majd másolja ki az Aláírási titkos kulcs értékét, amelyet az Exayard csak egyszer jelenít meg. Minden cég, amely telepítette az alkalmazást, a megadott hatóköreinek megfelelő eseményeket küldi. Az alkalmazás emellett megkapja az app.installed, az app.scopes_approved és az app.uninstalled eseményt, amikor egy cég telepíti, bővebb hozzáférést hagy jóvá neki, vagy eltávolítja. A kézbesítések megnevezik a cégüket, és ugyanúgy vannak aláírva, mint a többi webhook.
Ugyanebben a párbeszédablakban szüneteltetheti (Szüneteltetés) és folytathatja (Folytatás) a kézbesítéseket, valamint elérhető a Titkos kulcs cseréje és a Webhook törlése is.
Csatlakoztatott alkalmazások
A Csatlakoztatott alkalmazások a cégében telepített alkalmazásokat sorolja fel. Ezt minden tag látja. Telepíteni, eltávolítani és jóváhagyni csak az adminisztrátorok tudnak.
Minden sor megjeleníti az alkalmazás nevét, azt, hogy Ellenőrizve állapotú-e, a céget, amely készítette, azt, hogy ki és mikor telepítette, valamint a megadott hatóköröket.
Alkalmazás telepítése
Nyissa meg az alkalmazás telepítési linkjét, vagy kattintson a mellette lévő Telepítés gombra az Alkalmazáskereső listájában. A párbeszédablak megmutatja, ki készítette az alkalmazást, ellenőrizve van-e, és milyen hatóköröket kér. Ezután válasszon:
Cég: bármely cég, amelyben Ön adminisztrátor. Az a cég, amelyben az alkalmazás már telepítve van, (telepítve) jelölést kap. Az ismételt telepítés elmenti az új beállításait.
Projektek: Összes projekt, vagy Csak ezek a projektek, ahol bejelölheti azokat a projekteket, amelyekhez az alkalmazás hozzáférhet, legfeljebb 500-at. Az alkalmazás a cég egyetlen más projektjéhez sem fér hozzá.
Havi AI-keret: az a legnagyobb összeg, amennyibe az alkalmazás AI-munkája számlázási hónaponként kerülhet a cégének, a számlázási pénznemében. Ha üresen hagyja, az érték Nincs keret.
Kattintson a Telepítés gombra. Ha az alkalmazás bejelentkezteti Önt, az Exayard ezután továbbviszi az alkalmazásba való bejelentkezés befejezéséhez. Ha Ön tag, de nem adminisztrátor, a párbeszédablak megmondja, melyik cég adminisztrátora telepítheti. A Link másolása gombbal elküldheti neki a linket.
A projektek későbbi módosításához nyissa meg újra a telepítési linket, és telepítse az alkalmazást az új választással.
Bővebb hozzáférés jóváhagyása
Amikor egy alkalmazás további hatóköröket kér, a sorában a Bővebb hozzáférést kér felirat jelenik meg az új hatókörökkel. Egy adminisztrátor a Jóváhagyás gombra kattintva adhatja meg őket. Addig az alkalmazás megtartja a korábbi hozzáférését.
Alkalmazás eltávolítása
Nyissa meg az alkalmazás További műveletek menüjét, kattintson az Eltávolítás elemre, és erősítse meg. Az alkalmazás azonnal elveszíti a hozzáférését a cégéhez, és a webhookjai leállnak. A már elindított AI-munkája ettől még befejeződik.
Alkalmazáskereső
Az Alkalmazáskereső a Csatlakoztatott alkalmazások részen belül jelenik meg. Azokat az ellenőrzött alkalmazásokat sorolja fel, amelyeket a készítőik listázni szerettek volna. A cégében már meglévő alkalmazásnál a Telepítve felirat látható. Bármely más alkalmazásnál kattintson a Telepítés gombra a telepítési párbeszédablak megnyitásához.
Az Ön személyes csatlakozásai
Az Ön személyes csatlakozásai azokat az AI-eszközöket és egyéb alkalmazásokat sorolja fel, amelyeket a saját Exayard-fiókjához csatlakoztatott, például a ChatGPT-t vagy a Claude-ot. A Csatlakoztatott alkalmazások tetején jelenik meg, és mindenki csak a sajátjait látja. A személyes csatlakozás az Ön nevében jár el, így mindenhez hozzáfér, amihez Ön is.
Minden csatlakozásnál látható, mikor használták először és utoljára, és mely cégekben használták. Egy csatlakozás leállításához nyissa meg a További műveletek menüjét, kattintson az Eltávolítás elemre, és erősítse meg. A következő hívását a rendszer elutasítja. A csatlakozás Eltávolítva jelöléssel a listában marad, és az Újbóli engedélyezés elemmel visszaengedheti. Új eszköz csatlakoztatásáról lásd: Az Exa összekapcsolása az AI-asszisztensével.
Fiókok az ügyfelei számára
Az alkalmazása az API-n keresztül Exayard-cégeket hozhat létre azoknak az ügyfeleinek, akik az Exayardot csak az Ön termékén keresztül használják. Ezek a cégek az Ön cégének tulajdonában vannak, és a bennük végzett AI-munkáért az Ön cége fizet. Nincsenek saját tagjaik, és az alkalmazásai automatikusan telepítve vannak bennük.
A Fiókok az ügyfelei számára az adminisztrátorok számára sorolja fel ezeket, minden cégnél a Név és a Létrehozva dátum feltüntetésével. Egy cég lezárásához kattintson a Lezárás gombra, és erősítse meg. A cégben lévő összes alkalmazás elveszíti a hozzáférését.
Első lépések
A Gyorsindítás kártya egy előre elkészített promptot tartalmaz AI-szerkesztőkhöz, például a Claude-hoz vagy a Cursorhoz. Kattintson a Prompt másolása gombra, és illessze be a szerkesztőbe. A prompt tartalmazza az API alap URL-címét, a hitelesítés formátumát, a hatóköröket és a webhookok aláírási sémáját, így az AI működő integrációt készíthet, és rákérdezhet a szükséges részletekre. Ezt a kártyát csak az adminisztrátorok látják, mert API-kulcsot igényel.
A Dokumentáció kártya a Dokumentáció megnyitása gombbal a teljes fejlesztői dokumentációra mutat, valamint az OpenAPI-specifikáció leírásra, amely minden útvonalat és sémát ismertet. Az adminisztrátorok a Csatlakozás a Claude-hoz vagy a Cursorhoz elemet is látják, amely megnyitja az AI-asszisztensek Exayardhoz csatlakoztatásának beállítását.
Naplók
A Naplók az API-nak küldött kéréseket mutatja, a legújabbal kezdve. Minden sor megjeleníti a Metódus, Útvonal, Állapot, Idő és Késleltetés értékét. A régebbi kérések megtekintéséhez kattintson alul a Továbbiak betöltése gombra.
Az adminisztrátorok minden kérést látnak. A tagok csak azokat a kéréseket látják, amelyek nem alkalmazáson keresztül érkeztek.
Az adminisztrátorok szűrhetnek Alkalmazás szerint, majd az adott alkalmazás egyik kulcsa szerint. Bárki megadhat egy Végfelhasználó értéket, hogy csak az adott ügyfél kéréseit lássa. A végfelhasználó az Ön saját azonosítója az egyik ügyfele számára. A kódja minden kéréssel elküldi az Exayard-End-User fejlécben. Soha ne használjon e-mail-címet azonosítóként.
Egy sor kiválasztásával megtekintheti annak összes részletét, beleértve a Kérésazonosító értékét, az alkalmazást és a végfelhasználót, valamint a Kérés törzse és a Válasz törzse adatokat. A naplók segítségével ellenőrizheti, hogy egy hívás sikeres volt-e, vagy kiderítheti, miért nem működik egy integráció.
Költés kulcsonként és végfelhasználónként
Az adminisztrátorok a Beállítások, majd a Használat oldalon, a Költés alkalmazásonként részben látják, mennyit költött az egyes alkalmazás ebben a hónapban. A saját alkalmazásai is itt szerepelnek. Minden alkalmazás alatt a Kulcsonként azt mutatja, mennyit költött az egyes kulcs, a Legnagyobb végfelhasználók pedig azt az öt végfelhasználót, aki a legtöbbet költötte. Az alkalmazás egyik kulcsához sem köthető költés Egyéb néven jelenik meg.
Havi AI-keret
Az alkalmazás havi AI-kerete az a legnagyobb összeg, amennyibe az AI-munkája számlázási hónaponként kerülhet a cégének. A beállításához nyissa meg az alkalmazás További műveletek menüjét a Költés alkalmazásonként részben, és kattintson a Havi AI-keret beállítása elemre. Adjon meg egy összeget a számlázási pénznemében, és kattintson a Mentés gombra. A keret megszüntetéséhez mentse el a mezőt üresen.
Amikor az alkalmazás eléri a keretét, az AI-munkáját a rendszer a számlázási hónap hátralévő részében elutasítja, még akkor is, ha a cégének van még AI-használata. A cég saját korlátai továbbra is érvényesek. Az emberek által saját maguk elindított AI-munka soha nem számít bele egy alkalmazás keretébe.
