Langkau ke kandungan utama

API pembangun dan webhook

Cipta kunci API, daftarkan titik akhir webhook, dan semak log permintaan daripada Pusat Pembangun.

Ditulis oleh Sarah Chen

Developer Center ialah tempat anda menyambungkan Exayard ke kod dan alat anda sendiri. Bukanya daripada Settings kemudian Developer. Dari sini anda mencipta API key, mendaftarkan titik akhir webhook, dan menyemak log langsung setiap permintaan API. Hanya pentadbir organisasi boleh mengakses halaman ini.

API key

API key mengesahkan permintaan ke API Exayard. Kunci tergolong dalam organisasi anda, jadi akaun yang betul dipilih secara automatik dan tiada ID organisasi untuk dihantar.

Buka tab API keys dalam kad Credentials dan klik butang +. Berikan kunci itu Name, kemudian pilih Scopes-nya. Pilih All untuk memberikan setiap skop, atau Specific untuk memilih kebenaran individu. Skop mengikut pembahagian baca dan tulis setiap sumber, seperti read:projects dan write:estimates. Skop admin:org ialah pemberian akses penuh. Pilih skop minimum yang diperlukan oleh integrasi anda.

Exayard menunjukkan kunci penuh sekali sahaja, tepat selepas anda menciptanya. Salinnya ketika itu, kerana ia tidak akan ditunjukkan lagi. Selepas itu, setiap kunci muncul dengan namanya, pratonton bertopeng seperti ak_••••1234, dan tarikh ia terakhir digunakan.

Gunakan ikon pensel untuk menamakan semula kunci atau menukar skopnya. Gunakan ikon tong sampah untuk Revoke kunci. Pembatalan adalah kekal dan sebarang integrasi yang menggunakan kunci itu berhenti berfungsi dengan serta-merta.

Kunci yang sama mengesahkan integrasi tanpa kod. Lihat Menyambungkan Exayard ke Zapier, Menyambungkan Exayard ke Make, dan Menyambungkan Exayard ke n8n. Untuk akses ejen dan editor AI, lihat Menyambung ke Claude dan alat AI lain.

Webhook

Webhook memberitahu Exayard untuk memaklumkan pelayan anda apabila sesuatu berlaku. Buka tab Webhooks dan klik + untuk menambah titik akhir. Masukkan URL yang sepatutnya menerima penghantaran dan Description pilihan.

Pilih Events yang hendak dilanggan. Pilih All untuk menerima setiap peristiwa, atau Specific untuk memilih daripada senarai:

Peristiwa

Tercetus apabila

project.created

Projek dicipta

project.updated

Projek diubah

project.archived

Projek diarkibkan

assessment.started

Penilaian takeoff bermula

assessment.completed

Penilaian selesai

assessment.approved

Penilaian diluluskan

assessment.cancelled

Penilaian dibatalkan

estimate.generated

Anggaran dijana

bid.generated

Bida dijana

file.processed

Fail yang dimuat naik selesai diproses

Apabila anda mencipta titik akhir, Exayard menunjukkan signing secret sekali sahaja. Salinnya ketika itu, kerana ia tidak ditunjukkan lagi.

Mengamankan penghantaran webhook

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 titik akhir anda.

Untuk mengesahkan penghantaran, kira semula tandatangan dengan rahsia anda, sahkan cap masa berada dalam lima minit dari sekarang, dan bandingkan digest. Penghantaran yang gagal akan dicuba semula dengan backoff eksponen selama lebih kurang tiga hari.

Untuk mengedit titik akhir, klik ikon pensel. Anda boleh menukar URL, perihalan, dan peristiwa, serta menetapkan Status-nya kepada Active atau Paused. Titik akhir yang dijeda berhenti menerima penghantaran. Dialog yang sama mempunyai butang Rotate secret. Memutar mengeluarkan rahsia baharu dan rahsia lama berhenti berfungsi dengan serta-merta, jadi kemas kini pelayan anda sebelum anda memutarnya. Ikon tong sampah memadamkan titik akhir dan menamatkan semua penghantaran kepadanya.

Permulaan pantas

Kad Quick start menyimpan gesaan siap sedia untuk editor AI seperti Claude atau Cursor. Klik Copy prompt dan tampalkannya ke editor anda. Gesaan tersebut termasuk URL asas API, format pengesahan, perbendaharaan kata skop, dan skema tandatangan webhook, supaya AI boleh merangka integrasi yang berfungsi dan meminta anda butiran yang diperlukannya.

Dokumentasi

Kad Documentation memautkan ke dokumen pembangun penuh dan OpenAPI spec, yang menerangkan setiap laluan dan skema. Connect MCP membuka penyediaan untuk menyambungkan ejen AI terus ke Exayard.

Log

Bahagian Logs merekodkan permintaan API anda yang terkini merentas kedua-dua REST API dan MCP. Setiap baris menunjukkan kaedah, laluan, status respons, dan kependaman. Pilih baris untuk melihat butiran penuhnya, termasuk ID permintaan serta badan permintaan dan respons. Gunakan log untuk mengesahkan panggilan berjaya atau untuk menyahpepijat integrasi yang gagal.

Adakah ini menjawab soalan anda?