Tetapan Pembangun ialah tempat anda menyambungkan Exayard dengan kod anda sendiri dan dengan aplikasi yang dibina oleh syarikat lain. Buka Tetapan kemudian Pembangun. Hanya pentadbir syarikat yang melihatnya dalam menu Tetapan. Ahli yang membuka halaman ini boleh membacanya tetapi tidak boleh mengubah apa-apa.

Aplikasi, kunci API, webhook dan log disediakan dalam setiap pelan, termasuk Free. Hanya kerja AI yang dicaj.

Aplikasi ialah salah satu integrasi anda, seperti "Acme estimator" atau "Nightly sync". Setiap kunci API dimiliki oleh sebuah aplikasi. Aplikasi ialah bahagian pertama pada halaman ini. Setiap ahli boleh membacanya. Hanya pentadbir yang boleh mencipta atau mengubah aplikasi.

Klik Aplikasi baharu dan isikan Nama, Penerangan, Laman utama, E-mel sokongan dan Skopnya. Skop dibahagikan kepada baca dan tulis bagi setiap sumber, seperti read:projects dan write:estimates. Aplikasi tidak boleh meminta skop admin:org. Sesebuah syarikat boleh mempunyai sehingga 25 aplikasi.

Setiap aplikasi memaparkan bila ia dicipta dan had kadarnya, seperti "Sehingga 60 permintaan seminit bagi setiap syarikat dan 600 secara keseluruhan". Menu Lagi tindakan aplikasi mengandungi:

Kunci API membolehkan kod anda sendiri memanggil API Exayard. Kunci berada di dalam aplikasi, di bawah Kunci. Kunci berfungsi dalam syarikat aplikasinya sendiri, jadi tiada ID syarikat yang perlu dihantar.

Untuk mencipta kunci, klik Kunci baharu dalam aplikasi. Berikan kunci itu Nama, seperti "Production". Di bawah Skop, pilih Semua untuk setiap skop yang dimiliki aplikasi, atau Tertentu untuk memilih lebih sedikit. Tetapkan tarikh Tamat tempoh pilihan jika kunci itu untuk kerja jangka pendek. Kunci berfungsi sehingga hujung hari tersebut. Klik Cipta.

Exayard memaparkan kunci penuh sekali sahaja. Salin kunci itu ketika itu juga, kerana ia tidak akan dipaparkan lagi. Exayard hanya menyimpan salinan yang dikacau, jadi kunci yang hilang tidak boleh dipulihkan. Cipta kunci baharu dan batalkan kunci lama.

Kunci bermula dengan exa_live_. Kunci yang dicipta dalam sandbox bermula dengan exa_test_. Selepas anda menciptanya, kunci itu memaparkan namanya, pratonton seperti exa_live_...AbCd, dan Terakhir digunakan atau Tidak pernah digunakan. Kunci yang mempunyai tarikh tamat tempoh memaparkan Tamat tempoh dan tarikhnya, dan kunci yang telah tamat tempoh memaparkan Sudah tamat tempoh.

Aplikasi boleh mempunyai sehingga 25 kunci aktif. Kunci yang sudah tamat tempoh masih dikira sehingga anda membatalkannya. Untuk menukar kunci tanpa gangguan, cipta kunci kedua, alihkan pelayan anda kepadanya, kemudian batalkan kunci pertama.

Buka menu Tindakan kunci untuk Namakan semula atau Batalkan kunci itu. Pembatalan tidak boleh dibuat asal, dan kunci itu berhenti berfungsi dalam masa 30 saat.

Jika sesuatu kunci muncul di tempat awam, seperti repositori kod awam, Exayard membatalkannya, menghantar e-mel kepada pentadbir anda, dan mengekalkannya dalam senarai dengan tanda Ditemui terdedah kepada umum, dibatalkan.

Apabila syarikat lain telah memasang aplikasi anda, dialog kunci baharu turut memaparkan Berfungsi dalam. Syarikat ini ialah pilihan lalai. Setiap syarikat yang memasangnya mencipta kunci yang digunakan oleh pelayan anda dalam setiap syarikat tersebut. Setiap panggilan kemudian menamakan syarikatnya dalam pengepala Exayard-Organization-Id.

Kunci yang sama turut menyambungkan alat tanpa kod. Lihat Menyambungkan Exayard kepada Zapier, Menyambungkan Exayard kepada Make dan Menyambungkan Exayard kepada n8n. Untuk pembantu AI, lihat Menyambungkan Exa ke pembantu AI anda.

Kunci yang dicipta sebelum kunci berada di dalam aplikasi bermula dengan ak_. Kunci ini terus berfungsi, tetapi kunci baharu jenis ini tidak boleh dicipta lagi. Kunci ini dipaparkan di bawah Kunci lama di bahagian bawah halaman, hanya selagi masih ada.

Setiap pentadbir melihat setiap kunci syarikat di situ, tidak kira siapa yang menciptanya. Kunci yang dicipta oleh orang lain memaparkan Dibuat oleh dan nama mereka. Setiap orang juga melihat kunci peribadi mereka sendiri. Klik ikon tong sampah untuk Batalkan kunci. Kunci itu berhenti berfungsi serta-merta.

Sandbox ialah syarikat ujian yang dipautkan kepada syarikat anda. Gunakannya untuk membina dan menguji integrasi tanpa menyentuh projek sebenar anda. Hanya pentadbir yang melihat Sandbox.

Klik Sandbox baharu, berikan Nama, dan klik Cipta. Sesebuah syarikat boleh mempunyai sehingga 5 sandbox. Buka menukarkan anda ke dalam sandbox, dan penukar syarikat menandakannya sebagai Sandbox. Cipta aplikasi dan kunci di situ seperti biasa. Kuncinya bermula dengan exa_test_. Untuk beroperasi secara langsung, cipta aplikasi dan kunci yang sama dalam syarikat sebenar anda dan gantikan kunci dalam kod anda.

Sandbox mengikut pelan syarikat anda, dan syarikat anda membayar penggunaannya. Sandbox tidak mempunyai pengebilan sendiri dan tidak menerima penggunaan AI bulanan sendiri. Webhook dan integrasi berfungsi sama seperti dalam syarikat sebenar anda.

Sandbox tidak menghantar e-mel perkongsian bida atau salinan yang ditandatangani kepada orang di luarnya, dan tidak menghantar sebarang SMS. Semua ini dipaparkan sebagai "Tidak dihantar kerana syarikat ini ialah sandbox". Jemputan untuk menyertai sandbox dihantar seperti biasa.

Pengukuran kuantiti dan pembacaan fail dalam sandbox mengembalikan hasil yang disalin daripada projek contoh kami, tanpa kos. Pengukuran kuantiti itu, halamannya dan webhook yang dihantar apabila pengukuran kuantiti itu selesai ditandakan sebagai contoh. Anggaran, sebut harga, carian elemen dan sembang juga menjawab dengan contoh, tanpa kos.

Untuk mengalih keluar sandbox, klik Padam pada barisnya, kemudian Padam sandbox. Sandbox itu ditutup, kuncinya berhenti berfungsi, dan datanya dipadam kemudian.

Webhook mengarahkan Exayard untuk memaklumkan pelayan anda apabila sesuatu berlaku dalam syarikat anda. Setiap ahli boleh membaca senarainya. Hanya pentadbir yang boleh menambah atau mengubah webhook.

Klik Cipta webhook, masukkan URL yang akan menerima penghantaran, dan tambah Penerangan pilihan. Pilih Peristiwa yang hendak dihantar. Pilih Semua untuk menerima setiap peristiwa, termasuk peristiwa baharu, atau Tertentu untuk memilih daripada senarai. Setiap peristiwa dan kandungannya disenaraikan dalam katalog peristiwa webhook.

Apabila anda mencipta webhook, Exayard memaparkan Rahsia tandatangannya sekali sahaja. Salin rahsia itu ketika itu juga, kerana ia tidak akan dipaparkan lagi.

Buka menu Lagi tindakan webhook untuk tindakan lain:

Peristiwa ujian dan penghantaran semula dihantar sekali sahaja dan tidak pernah dicuba semula.

Setiap penghantaran membawa pengepala Exayard-Signature dalam bentuk t=<unix>,v1=<digest>. Exayard membina tandatangan dengan menggabungkan cap masa dan badan permintaan, kemudian menandatanganinya dengan HMAC-SHA256 menggunakan rahsia webhook anda.

Setiap penghantaran juga membawa pengepala Exayard-Event-Id, Exayard-Event-Type dan Exayard-Organization-Id. Badan JSON mempunyai medan organizationId yang menamakan syarikat asal peristiwa tersebut. Pengepala membawa ID yang sama, jadi anda boleh menghalakan penghantaran sebelum membaca badannya. Tandatangan meliputi keseluruhan badan, termasuk organizationId.

Oleh sebab setiap penghantaran menamakan syarikatnya, satu alamat penerima boleh melayani banyak syarikat. Daftarkan URL yang sama dalam setiap syarikat dan halakan setiap penghantaran mengikut organizationId. Setiap webhook mempunyai rahsianya sendiri, jadi pilih rahsia mengikut Exayard-Organization-Id sebelum anda mengesahkan.

Untuk mengesahkan penghantaran, kira semula tandatangan menggunakan rahsia anda, pastikan cap masa berada dalam lingkungan lima minit dari masa kini, dan bandingkan nilai cerna.

Penghantaran yang gagal dicuba sehingga 10 kali secara keseluruhan, dalam tempoh lebih kurang 80 jam, dengan selang masa yang semakin panjang antara setiap cubaan. Setiap cubaan menghantar badan yang sama dan ID peristiwa yang sama. Ubah hala dikira sebagai kegagalan.

Aplikasi anda berfungsi dalam syarikat anda sendiri sebaik sahaja anda menciptanya. Setiap aplikasi juga mempunyai bahagian Benarkan syarikat lain memasang aplikasi ini. Bahagian ini memaparkan sama ada aplikasi itu Disemak, Semakan diminta atau Belum disemak, Alamat log masuknya, ID kliennya, dan berapa banyak syarikat yang boleh memasangnya.

Pentadbir membuka menu Tindakan pemasangan untuk tindakan berikut:

Aplikasi baharu boleh dipasang dalam sehingga 25 syarikat selain syarikat anda sendiri, dan ia tidak dipaparkan dalam Cari aplikasi. Syarikat di bawah Akaun untuk pelanggan anda tidak dikira dalam had tersebut. Setelah diluluskan, aplikasi memaparkan Disemak dan had pemasangan ditarik balik. Gunakan Tunjukkan dalam Cari aplikasi untuk menyenaraikannya dalam direktori setiap syarikat, atau Sembunyikan daripada Cari aplikasi untuk mengeluarkannya. Aplikasi yang Digantung tidak boleh memanggil Exayard sehingga sokongan menarik balik penggantungan itu, dan pemasangannya dikekalkan.

Apabila anda mengalih keluar skop daripada aplikasi, setiap pemasangan kehilangan skop itu serta-merta. Apabila anda menambah skop, setiap syarikat mengekalkan akses semasanya sehingga salah seorang pentadbirnya meluluskan skop baharu itu.

Buka menu Lagi tindakan aplikasi dan klik Webhook. Masukkan URL dan klik Cipta, kemudian salin Rahsia tandatangan, yang dipaparkan oleh Exayard sekali sahaja. Setiap syarikat yang memasang aplikasi itu menghantar peristiwa yang diliputi oleh skop yang diberikannya. Aplikasi anda juga menerima app.installed, app.scopes_approved dan app.uninstalled apabila sesebuah syarikat memasangnya, meluluskan akses yang lebih luas atau mengalih keluarnya. Penghantaran menamakan syarikatnya dan ditandatangani dengan cara yang sama seperti webhook lain.

Dialog yang sama membolehkan anda Jeda dan Sambung semula penghantaran, Tukar rahsia dan Padam webhook.

Aplikasi bersambung menyenaraikan aplikasi yang dipasang dalam syarikat anda. Setiap ahli boleh melihatnya. Hanya pentadbir yang boleh memasang, mengalih keluar atau meluluskan.

Setiap baris memaparkan nama aplikasi, sama ada ia Disemak, syarikat yang membinanya, siapa yang memasangnya dan bila, serta skop yang diberikan kepadanya.

Buka pautan pemasangan aplikasi itu, atau klik Pasang di sebelahnya dalam Cari aplikasi. Dialog memaparkan siapa yang membina aplikasi itu, sama ada ia disemak, dan skop yang dimintanya. Kemudian pilih:

Klik Pasang. Jika aplikasi itu membolehkan anda log masuk, Exayard kemudian membawa anda untuk menyelesaikan log masuk ke aplikasi tersebut. Jika anda seorang ahli tetapi bukan pentadbir, dialog memberitahu anda pentadbir syarikat mana yang boleh memasangnya. Klik Salin pautan untuk menghantarnya kepada mereka.

Untuk menukar projek kemudian, buka pautan pemasangan sekali lagi dan pasang dengan pilihan baharu.

Apabila aplikasi meminta lebih banyak skop, barisnya memaparkan Meminta akses tambahan bersama skop baharu itu. Pentadbir mengklik Luluskan untuk memberikannya. Sehingga itu, aplikasi mengekalkan akses yang dimilikinya sebelum ini.

Buka menu Lagi tindakan aplikasi itu, klik Alih keluar dan sahkan. Aplikasi itu kehilangan akses kepada syarikat anda serta-merta dan webhooknya berhenti. Kerja AI yang telah dimulakannya tetap diselesaikan.

Cari aplikasi dipaparkan di dalam Aplikasi bersambung. Ia menyenaraikan aplikasi yang telah disemak dan dipilih oleh pembinanya untuk disenaraikan. Aplikasi yang sudah ada dalam syarikat anda memaparkan Dipasang. Klik Pasang pada mana-mana aplikasi lain untuk membuka dialog pemasangan.

Sambungan peribadi anda menyenaraikan alat AI dan aplikasi lain yang anda sambungkan kepada akaun Exayard anda sendiri, seperti ChatGPT atau Claude. Ia dipaparkan di bahagian atas Aplikasi bersambung, dan hanya anda yang melihat sambungan anda sendiri. Sambungan peribadi bertindak sebagai anda, jadi ia boleh mencapai apa sahaja yang boleh anda capai.

Setiap sambungan memaparkan bila ia mula-mula dan terakhir digunakan, serta syarikat tempat ia digunakan. Untuk menghentikannya, buka menu Lagi tindakannya, klik Alih keluar dan sahkan. Panggilan seterusnya akan ditolak. Sambungan itu kekal dalam senarai dengan tanda Dialih keluar, dan Benarkan semula membolehkannya masuk semula. Untuk menyambungkan alat baharu, lihat Menyambungkan Exa ke pembantu AI anda.

Aplikasi anda boleh mencipta syarikat Exayard melalui API untuk pelanggan yang menggunakan Exayard hanya melalui produk anda. Syarikat anda memiliki syarikat ini dan membayar kerja AI yang dijalankan di dalamnya. Syarikat ini tidak mempunyai ahli sendiri, dan aplikasi anda dipasang di dalamnya secara automatik.

Akaun untuk pelanggan anda menyenaraikan syarikat tersebut untuk pentadbir, bersama Nama setiap syarikat dan tarikh ia Dicipta. Klik Lepaskan dan sahkan untuk menutup salah satunya. Setiap aplikasi di dalamnya kehilangan akses.

Kad Mula pantas mengandungi prompt sedia guna untuk editor AI seperti Claude atau Cursor. Klik Salin prompt dan tampalkannya ke dalam editor anda. Prompt itu merangkumi URL asas API, format pengesahan, skop dan skema tandatangan webhook, supaya AI boleh membina integrasi yang berfungsi dan meminta butiran yang diperlukannya daripada anda. Hanya pentadbir yang melihat kad ini, kerana ia memerlukan kunci API.

Kad Dokumentasi memaut kepada dokumentasi pembangun penuh melalui Buka dokumentasi, dan kepada Spesifikasi OpenAPI, yang menerangkan setiap laluan dan skema. Pentadbir juga melihat Sambung ke Claude atau Cursor, yang membuka persediaan untuk menyambungkan pembantu AI kepada Exayard.

Log memaparkan permintaan yang dibuat kepada API, yang terbaharu dahulu. Setiap baris memaparkan Kaedah, Laluan, Status, Masa dan Kependaman. Klik Muatkan lagi di bahagian bawah untuk melihat permintaan yang lebih lama.

Pentadbir melihat setiap permintaan. Ahli hanya melihat permintaan yang tidak datang melalui aplikasi.

Pentadbir boleh menapis mengikut Aplikasi, dan kemudian mengikut salah satu kunci aplikasi itu. Sesiapa sahaja boleh menaip Pengguna akhir untuk melihat permintaan pelanggan itu sahaja. Pengguna akhir ialah ID anda sendiri bagi salah seorang pelanggan anda. Kod anda menghantarnya bersama setiap permintaan dalam pengepala Exayard-End-User. Jangan sekali-kali menggunakan alamat e-mel sebagai ID.

Pilih satu baris untuk melihat butiran penuhnya, termasuk ID Permintaan, aplikasi dan pengguna akhir, serta Badan permintaan dan Badan respons. Gunakan log untuk mengesahkan bahawa panggilan berjaya atau untuk mengetahui sebab integrasi gagal.

Pentadbir melihat perbelanjaan setiap aplikasi bulan ini di bawah Perbelanjaan mengikut aplikasi dalam Tetapan kemudian Penggunaan. Aplikasi anda sendiri turut disenaraikan di situ. Di bawah setiap aplikasi, Mengikut kunci memaparkan perbelanjaan setiap kunci, dan Pengguna akhir teratas memaparkan lima pengguna akhir yang paling banyak berbelanja. Perbelanjaan yang tidak terikat pada salah satu kunci aplikasi dipaparkan sebagai Lain-lain.

Had AI bulanan aplikasi ialah jumlah maksimum kos kerja AI aplikasi itu kepada syarikat anda bagi setiap bulan pengebilan. Untuk menetapkannya, buka menu Lagi tindakan aplikasi di bawah Perbelanjaan mengikut aplikasi dan klik Tetapkan had AI bulanan. Masukkan jumlah dalam mata wang pengebilan anda dan klik Simpan. Simpan medan kosong untuk mengalih keluar had.

Apabila aplikasi mencapai hadnya, kerja AI aplikasi itu ditolak bagi baki bulan pengebilan, walaupun syarikat anda masih mempunyai baki penggunaan AI. Had syarikat anda sendiri tetap terpakai. Kerja AI yang dimulakan sendiri oleh orang tidak pernah dikira dalam had aplikasi.