Lewati ke konten utama

API pengembang dan webhook

Buat kunci API, daftarkan endpoint webhook, dan tinjau log permintaan dari Developer Center.

Ditulis oleh Sarah Chen

Developer Center adalah tempat Anda menghubungkan Exayard ke kode dan alat Anda sendiri. Buka dari Settings lalu Developer. Dari sini Anda membuat kunci API, mendaftarkan endpoint webhook, dan meninjau log langsung dari setiap permintaan API. Hanya admin organisasi yang dapat mengakses halaman ini.

Kunci API

Kunci API mengautentikasi permintaan ke API Exayard. Kunci dimiliki oleh organisasi Anda, jadi akun yang tepat dipilih secara otomatis dan tidak ada ID organisasi yang perlu diteruskan.

Buka tab API keys di kartu Credentials dan klik tombol +. Beri kunci sebuah Name, lalu pilih Scopes-nya. Pilih All untuk memberikan setiap scope, atau Specific untuk memilih izin individual. Scope mengikuti pembagian read dan write per resource, seperti read:projects dan write:estimates. Scope admin:org adalah pemberian akses penuh. Pilih scope seminimal yang dibutuhkan integrasi Anda.

Exayard menampilkan kunci lengkap satu kali, tepat setelah Anda membuatnya. Salin saat itu, karena kunci tidak akan pernah ditampilkan lagi. Setelah itu, setiap kunci muncul dengan namanya, pratinjau yang disamarkan seperti ak_••••1234, dan tanggal terakhir kali digunakan.

Gunakan ikon pensil untuk menamai kembali kunci atau mengubah scope-nya. Gunakan ikon tempat sampah untuk Revoke kunci. Pencabutan bersifat permanen dan integrasi apa pun yang menggunakan kunci tersebut langsung berhenti bekerja.

Kunci yang sama mengautentikasi integrasi tanpa kode. Lihat Menghubungkan Exayard ke Zapier, Menghubungkan Exayard ke Make, dan Menghubungkan Exayard ke n8n. Untuk akses agen dan editor AI, lihat Menghubungkan ke Claude dan alat AI lainnya.

Webhook

Webhook memberi tahu Exayard untuk memberitahukan server Anda saat sesuatu terjadi. Buka tab Webhooks dan klik + untuk menambahkan endpoint. Masukkan URL yang akan menerima pengiriman dan Description opsional.

Pilih Events mana yang akan dilanggan. Pilih All untuk menerima setiap peristiwa, atau Specific untuk memilih dari daftar:

Peristiwa

Terpicu saat

project.created

Sebuah proyek dibuat

project.updated

Sebuah proyek diubah

project.archived

Sebuah proyek diarsipkan

assessment.started

Asesmen takeoff dimulai

assessment.completed

Sebuah asesmen selesai

assessment.approved

Sebuah asesmen disetujui

assessment.cancelled

Sebuah asesmen dibatalkan

estimate.generated

Sebuah estimasi dibuat

bid.generated

Sebuah penawaran dibuat

file.processed

File yang diunggah selesai diproses

Ketika Anda membuat endpoint, Exayard menampilkan signing secret satu kali. Salin saat itu, karena tidak ditampilkan lagi.

Mengamankan pengiriman webhook

Setiap pengiriman membawa header Exayard-Signature dalam bentuk t=<unix>,v1=<digest>. Exayard menyusun tanda tangan dengan menggabungkan stempel waktu dan isi permintaan, lalu menandatanganinya dengan HMAC-SHA256 menggunakan secret endpoint Anda.

Untuk memverifikasi pengiriman, hitung ulang tanda tangan dengan secret Anda, pastikan stempel waktunya berada dalam lima menit dari sekarang, lalu bandingkan digest-nya. Pengiriman yang gagal dicoba ulang dengan exponential backoff selama kira-kira tiga hari.

Untuk mengedit endpoint, klik ikon pensil. Anda dapat mengubah URL, deskripsi, dan peristiwa, serta mengatur Status-nya ke Active atau Paused. Endpoint yang dijeda berhenti menerima pengiriman. Dialog yang sama memiliki tombol Rotate secret. Memutar menerbitkan secret baru dan secret lama langsung berhenti bekerja, jadi perbarui server Anda sebelum Anda memutarnya. Ikon tempat sampah menghapus endpoint dan mengakhiri semua pengiriman ke endpoint tersebut.

Mulai cepat

Kartu Quick start berisi prompt siap pakai untuk editor AI seperti Claude atau Cursor. Klik Copy prompt dan tempelkan ke editor Anda. Prompt menyertakan URL dasar API, format autentikasi, kosakata scope, dan skema penandatanganan webhook, sehingga AI dapat membuat rangka integrasi yang berfungsi dan menanyakan detail yang dibutuhkannya.

Dokumentasi

Kartu Documentation menautkan ke dokumentasi developer lengkap dan OpenAPI spec, yang menjelaskan setiap rute dan skema. Connect MCP membuka penyiapan untuk menghubungkan agen AI langsung ke Exayard.

Log

Bagian Logs mencatat permintaan API terbaru Anda di REST API maupun MCP. Setiap baris menampilkan metode, path, status respons, dan latensi. Pilih sebuah baris untuk melihat detail lengkapnya, termasuk ID permintaan serta isi permintaan dan respons. Gunakan log untuk memastikan sebuah panggilan berhasil atau untuk men-debug integrasi yang gagal.

Apakah pertanyaan Anda terjawab?