開發人員設定是您將 Exayard 與自有程式碼,以及其他公司開發的應用程式串接的地方。請開啟設定,然後開啟開發人員。只有公司管理員會在設定選單中看到此項目。成員開啟此頁面時只能檢視,無法變更任何內容。
應用程式、API 金鑰、Webhook 與日誌適用於所有方案,包括免費方案。只有 AI 工作會收費。
應用程式
應用程式是您的一項整合,例如「Acme estimator」或「Nightly sync」。每把 API 金鑰都隸屬於一個應用程式。應用程式是頁面上的第一個區段。每位成員都可以檢視,但只有管理員可以建立或變更應用程式。
點選新增應用程式,並填寫其名稱、說明、首頁、支援電子郵件與權限範圍。權限範圍依各項資源區分為讀取與寫入,例如 read:projects 與 write:estimates。應用程式無法要求 admin:org 權限範圍。每家公司最多可擁有 25 個應用程式。
每個應用程式都會顯示其建立時間與速率限制,例如「每家公司每分鐘最多 60 個請求,總計最多 600 個」。應用程式的更多動作選單包含:
編輯可變更應用程式的詳細資料與權限範圍。
Webhook可設定單一位址,接收來自每家安裝該應用程式之公司的事件。
刪除應用程式會移除該應用程式並撤銷其所有金鑰。每家安裝它的公司都會失去存取權。
API 金鑰
API 金鑰可讓您自己的程式碼呼叫 Exayard API。金鑰位於應用程式內的金鑰下。金鑰在其應用程式所屬的公司中有效,因此無須傳入公司 ID。
若要建立金鑰,請在應用程式中點選新增金鑰。為金鑰輸入名稱,例如「Production」。在權限範圍下,選擇全部可使用應用程式擁有的所有權限範圍,選擇指定事件則可挑選較少的權限範圍。如果金鑰只用於短期工作,可選擇設定到期日。金鑰在該日結束前皆有效。點選建立。
Exayard 只會顯示一次完整金鑰。請當下複製,因為之後將不會再次顯示。Exayard 只保留經過加密處理的副本,因此遺失的金鑰無法復原。請建立新金鑰並撤銷舊金鑰。
金鑰以 exa_live_ 開頭。在沙箱中建立的金鑰則以 exa_test_ 開頭。建立後,金鑰會顯示其名稱、類似 exa_live_...AbCd 的預覽,以及上次使用或從未使用。設有到期日的金鑰會顯示到期日及其日期,已到期的金鑰則會顯示已到期。
一個應用程式最多可有 25 把有效金鑰。已到期的金鑰在您撤銷之前仍會計入。若要在不中斷服務的情況下更換金鑰,請先建立第二把金鑰,將您的伺服器改用該金鑰,再撤銷第一把。
開啟金鑰的金鑰動作選單,即可將其重新命名或撤銷。撤銷後無法復原,金鑰會在 30 秒內停止運作。
如果金鑰出現在公開的地方,例如公開的程式碼儲存庫,Exayard 會撤銷該金鑰、以電子郵件通知您的管理員,並將其保留在清單中,標示為於公開處發現,已撤銷。
當其他公司已安裝您的應用程式時,新增金鑰對話方塊也會顯示適用範圍。預設為此公司。選擇所有已安裝此應用程式的公司會建立一把供您的伺服器在每家這類公司中使用的金鑰。之後每次呼叫都會在 Exayard-Organization-Id 標頭中標示其所屬公司。
同一把金鑰也可用於連接無程式碼工具。請參閱將 Exayard 連接至 Zapier、將 Exayard 連接至 Make 及將 Exayard 連接至 n8n。若要連接 AI 助理,請參閱將 Exa 連接至你的 AI 助理。
舊版金鑰
在金鑰改為隸屬於應用程式之前建立的金鑰以 ak_ 開頭。這些金鑰仍可繼續使用,但無法再建立新的。只要仍有這類金鑰,它們就會顯示在頁面底部的舊版金鑰下。
每位管理員都會在此看到公司的所有金鑰,無論建立者是誰。由其他人建立的金鑰會顯示建立者及其姓名。每個人也會看到自己的個人金鑰。點選垃圾桶圖示即可撤銷金鑰,金鑰會立即停止運作。
沙箱
沙箱是與您的公司連結的測試公司。您可以用它來開發與測試整合,而不會影響您的實際專案。只有管理員看得到沙箱。
點選新增沙箱,輸入名稱,然後點選建立。每家公司最多可擁有 5 個沙箱。點選開啟即可切換至沙箱,公司切換器會將其標示為沙箱。請照常在其中建立應用程式與金鑰。沙箱中的金鑰以 exa_test_ 開頭。若要正式上線,請在您的實際公司中建立相同的應用程式與金鑰,並在程式碼中替換金鑰。
沙箱沿用您公司的方案,其用量由您的公司支付。沙箱沒有自己的帳單,也沒有自己的每月 AI 用量。Webhook 與整合的運作方式與您的實際公司相同。
沙箱不會將投標分享電子郵件或簽署副本寄給沙箱以外的人,也不會傳送簡訊。這些項目會顯示為「此公司為沙箱,因此未傳送」。加入沙箱的邀請會照常寄出。
沙箱中的數量計算與檔案讀取會傳回複製自我們範例專案的結果,不會收費。數量計算、其頁面,以及數量計算完成時傳送的 Webhook 都會標示為範例。估價、投標、元素搜尋與聊天同樣會以範例回應,也不會收費。
若要移除沙箱,請點選其所在列的刪除,然後點選刪除沙箱。沙箱會關閉,其金鑰會停止運作,其資料之後也會被清除。
Webhook
Webhook 可讓 Exayard 在您的公司發生特定事件時通知您的伺服器。每位成員都可以檢視清單,但只有管理員可以新增或變更 Webhook。
點選建立 Webhook,輸入接收傳送內容的 URL,並可選擇填寫說明。選擇要傳送的事件。選擇全部可接收所有事件(包括新增的事件),選擇指定事件則可從清單中挑選。所有事件及其內容都列在 Webhook 事件目錄中。
建立 Webhook 時,Exayard 會顯示一次其簽署密鑰。請當下複製,因為之後將不會再次顯示。
開啟 Webhook 的更多動作選單即可進行其餘操作:
編輯可變更 URL、說明與事件,並將其狀態設為啟用中或已暫停。已暫停的 Webhook 將不會接收任何傳送內容。對話方塊中也有輪替密鑰。舊密鑰會立即失效,因此請先更新您的伺服器。
傳送測試事件會傳送一個您所選事件類型的事件。對話方塊會等待您伺服器的回應,並顯示結果與回應代碼。測試事件會帶有
"test": true。傳送紀錄會列出最近 25 次傳送,以及其事件、狀態、回應代碼與嘗試次數。傳送狀態為待處理、重試中、已送達或失敗。管理員可點選重新傳送再次傳送。
刪除 Webhook 會終止對該 URL 的所有傳送。
測試事件與重新傳送只會傳送一次,且絕不會重試。
保護 Webhook 傳送安全
每次傳送都會附帶 Exayard-Signature 標頭,格式為 t=<unix>,v1=<digest>。Exayard 會將時間戳記與請求內文串接,再使用您 Webhook 的密鑰以 HMAC-SHA256 進行簽署,藉此產生簽章。
每次傳送也會附帶 Exayard-Event-Id、Exayard-Event-Type 及 Exayard-Organization-Id 標頭。JSON 內文包含 organizationId 欄位,標示事件來源的公司。標頭帶有相同的 ID,因此您可以在讀取內文之前先行路由傳送內容。簽章涵蓋整個內文,包括 organizationId。
由於每次傳送都會標示其所屬公司,因此單一接收位址可以服務多家公司。請在每家公司中註冊相同的 URL,並依 organizationId 路由每次傳送。每個 Webhook 都有各自的密鑰,因此請在驗證前依 Exayard-Organization-Id 選取對應的密鑰。
若要驗證傳送內容,請使用您的密鑰重新計算簽章,確認時間戳記與目前時間相差在五分鐘以內,然後比對摘要值。
傳送失敗時,系統會在約 80 小時內總共嘗試最多 10 次,每次嘗試的間隔會逐漸拉長。每次嘗試都會傳送相同的內文與相同的事件 ID。重新導向會視為失敗。
允許其他公司安裝您的應用程式
您的應用程式一建立就能在您自己的公司中運作。每個應用程式也有允許其他公司安裝此應用程式區塊。此區塊會顯示應用程式為已審查、已申請審查或未審查,以及其登入位址、用戶端 ID,和可安裝的公司數量。
管理員可開啟安裝動作選單進行以下操作:
編輯登入位址可設定當您的應用程式讓使用者以其 Exayard 帳戶登入時,Exayard 將使用者導回的位址。每行輸入一個位址,最多 10 個。每個位址都必須以
https://開頭,測試期間則可使用http://localhost。第一次儲存登入位址時,Exayard 會顯示一次應用程式的用戶端密鑰。複製安裝連結會複製一個可傳送給任何公司的連結,該連結會為該公司的管理員開啟安裝對話方塊。
申請審查會將應用程式送交 Exayard 支援團隊審查。
新的應用程式除了您自己的公司之外,最多可安裝於 25 家公司,且不會出現在尋找應用程式中。客戶帳戶下的公司不計入此上限。核准後,應用程式會顯示已審查,安裝數量限制也會解除。使用顯示於「尋找應用程式」可將其列在每家公司的目錄中,使用從「尋找應用程式」中隱藏則可將其下架。已停權的應用程式在支援團隊解除停權之前無法呼叫 Exayard,但其安裝會保留。
當您從應用程式移除權限範圍時,每個安裝都會立即失去這些權限範圍。當您新增權限範圍時,每家公司會維持其目前的存取權,直到其管理員核准新的權限範圍為止。
應用程式 Webhook
開啟應用程式的更多動作選單並點選 Webhook。輸入 URL 並點選建立,然後複製簽署密鑰,Exayard 只會顯示一次。每家安裝該應用程式的公司會傳送其授予之權限範圍所涵蓋的事件。當公司安裝應用程式、核准更大的存取權或移除應用程式時,您的應用程式也會收到 app.installed、app.scopes_approved 與 app.uninstalled。傳送內容會標示其所屬公司,簽署方式與其他 Webhook 相同。
同一個對話方塊也可讓您暫停與繼續傳送、輪替密鑰,以及刪除 Webhook。
已連接的應用程式
已連接的應用程式會列出您公司中已安裝的應用程式。每位成員都看得到此清單,但只有管理員可以安裝、移除或核准。
每一列會顯示應用程式的名稱、是否已審查、開發該應用程式的公司、安裝者與安裝時間,以及其獲得授予的權限範圍。
安裝應用程式
開啟應用程式的安裝連結,或在尋找應用程式中點選其旁邊的安裝。對話方塊會顯示應用程式的開發者、是否已審查,以及其要求的權限範圍。接著選擇:
公司:任何您擔任管理員的公司。已安裝該應用程式的公司會標示 (已安裝)。再次安裝會儲存您的新選擇。
專案:選擇所有專案,或選擇僅限這些專案並勾選應用程式可存取的專案,最多 500 個。應用程式無法存取公司中的其他任何專案。
每月 AI 上限:每個帳單月份中,應用程式的 AI 工作可為您公司產生的最高費用,以您的帳單幣別計算。保留空白即為無上限。
點選安裝。如果應用程式會讓您登入,Exayard 接著會帶您完成應用程式的登入。如果您是成員而非管理員,對話方塊會告訴您哪家公司的管理員可以安裝它。點選複製連結即可傳送給對方。
若之後要變更專案,請再次開啟安裝連結,並以新的選擇進行安裝。
核准更多存取權
當應用程式要求更多權限範圍時,其所在列會顯示要求更多存取權及新的權限範圍。管理員點選核准即可授予。在此之前,應用程式會維持原有的存取權。
移除應用程式
開啟應用程式的更多動作選單,點選移除並確認。應用程式會立即失去對您公司的存取權,其 Webhook 也會停止。它先前已啟動的 AI 工作仍會完成。
尋找應用程式
尋找應用程式位於已連接的應用程式中。它會列出開發者選擇公開列出的已審查應用程式。您公司已安裝的應用程式會顯示已安裝。在其他任何應用程式上點選安裝,即可開啟安裝對話方塊。
您的個人連接
您的個人連接會列出您連接至自己 Exayard 帳戶的 AI 工具與其他應用程式,例如 ChatGPT 或 Claude。它顯示在已連接的應用程式的頂端,且只有您看得到自己的連接。個人連接會以您的身分運作,因此可以存取您能存取的任何內容。
每個連接都會顯示首次與最近一次使用的時間,以及使用過它的公司。若要停用某個連接,請開啟其更多動作選單,點選移除並確認。它的下一次呼叫將會遭到拒絕。該連接會以已移除標示並保留在清單中,點選重新允許即可恢復其存取。若要連接新的工具,請參閱將 Exa 連接至你的 AI 助理。
客戶帳戶
您的應用程式可以透過 API,為只透過您的產品使用 Exayard 的客戶建立 Exayard 公司。這些公司由您的公司擁有,在其中執行的 AI 工作也由您的公司支付。這些公司沒有自己的成員,您的應用程式會自動安裝在其中。
客戶帳戶會為管理員列出這些公司,並顯示每家公司的名稱與建立時間。點選放棄並確認即可關閉公司。其中的每個應用程式都會失去存取權。
開始使用
快速入門卡片提供一段現成的提示詞,供 Claude 或 Cursor 等 AI 編輯器使用。點選複製提示詞並貼到您的編輯器中。提示詞包含 API 基礎 URL、驗證格式、權限範圍及 Webhook 簽署機制,讓 AI 能夠建立可運作的整合,並向您詢問所需的詳細資訊。由於此卡片需要 API 金鑰,因此只有管理員看得到。
說明文件卡片透過開啟文件連結至完整的開發者文件,並連結至 OpenAPI 規格,其中說明了每一個路由與結構描述。管理員還會看到連接至 Claude 或 Cursor,可開啟將 AI 助理連接至 Exayard 的設定。
日誌
日誌會顯示對 API 發出的請求,最新的排在最前面。每一列會顯示方法、路徑、狀態、時間及延遲。點選底部的載入更多即可查看較早的請求。
管理員會看到所有請求。成員只會看到並非透過應用程式發出的請求。
管理員可以依應用程式篩選,再依該應用程式的其中一把金鑰篩選。任何人都可以輸入終端使用者,只查看該客戶的請求。終端使用者是您為自己的某位客戶設定的 ID。您的程式碼會在每次請求的 Exayard-End-User 標頭中傳送此 ID。請勿使用電子郵件地址作為 ID。
選取某一列即可查看其完整詳細資料,包括請求 ID、應用程式與終端使用者,以及請求內容與回應內容。您可以使用日誌來確認呼叫是否成功,或找出整合失敗的原因。
各金鑰與終端使用者的支出
管理員可在設定中用量下的各應用程式支出,查看每個應用程式本月的支出。您自己的應用程式也會列在其中。在每個應用程式下,依金鑰會顯示每把金鑰的支出,主要終端使用者則會顯示支出最多的五位終端使用者。未與該應用程式任何金鑰相關聯的支出會顯示為其他。
每月 AI 上限
應用程式的每月 AI 上限,是每個帳單月份中其 AI 工作可為您公司產生的最高費用。若要設定上限,請在各應用程式支出下開啟應用程式的更多動作選單,並點選設定每月 AI 上限。以您的帳單幣別輸入金額並點選儲存。儲存空白欄位即可移除上限。
當應用程式達到上限時,其 AI 工作在該帳單月份的剩餘時間內都會遭到拒絕,即使您的公司仍有 AI 用量也一樣。您公司本身的上限仍然適用。由使用者自行啟動的 AI 工作絕不會計入應用程式的上限。
