Webhooks

Webhooks membolehkan anda menerima kemas kini masa nyata daripada Meshy apabila tugasan API anda selesai atau berubah status. Setelah dikonfigurasikan, Meshy akan POST payload acara dalam format json ke URL yang anda tentukan.

Mengapa Mencipta Webhooks

Menggunakan webhooks mempunyai beberapa kelebihan, terutamanya berkaitan dengan menyemak status tugasan API secara automatik. Webhooks memerlukan usaha dan kos yang lebih rendah berbanding meninjau API secara berterusan untuk mendapatkan kemas kini status tugasan. Webhooks juga membolehkan kemas kini hampir masa nyata dan akhirnya berskala lebih baik daripada peninjauan API. Ini juga membolehkan anda mengurus had kadar anda dengan lebih baik, terutamanya jika anda meninjau secara berterusan.

Persediaan & Konfigurasi

Untuk mengaktifkan webhooks, pergi ke halaman tetapan API apabila anda log masuk ke aplikasi web Meshy. Cari bahagian "Webhooks" di bawah API key anda dan klik butang "Create Webhook". Berikan URL https yang anda inginkan untuk menerima webhooks daripadanya dan aktifkan webhook untuk menerima kemas kini tugasan secara automatik daripada Meshy. Anda boleh mempunyai maksimum 5 webhook aktif bagi setiap akaun Meshy. Apabila webhook diaktifkan, semua kemas kini status tugasan API akan dihantar secara automatik ke URL payload. Untuk tujuan keselamatan, kami hanya membenarkan penghantaran webhooks ke URL https pada masa ini. Jika anda ingin mengkonfigurasikan ujian tempatan, lihat bahagian berikut.

Keperluan Penghantaran Webhook

Untuk webhook anda berfungsi seperti biasa dan terus menerima acara:

  • Pelayan anda mesti membalas dengan kod status HTTP di bawah 400 (cth., 200 OK, 202 Accepted).
  • Sebarang respons dengan kod status >= 400 akan dianggap sebagai penghantaran yang gagal.
  • Berbilang kegagalan berturut-turut mungkin:
    • Menyebabkan kemas kini progress tertangguh atau tiba tidak mengikut urutan
    • Menyahaktifkan webhook anda secara automatik selepas percubaan berulang (lihat Dasar Penyahaktifan Automatik)

Petua: Sentiasa kembalikan respons berjaya selepas anda mengesahkan dan menyimpan payload webhook, walaupun pemprosesan lanjut berlaku secara tak segerak.

Memajukan Webhooks untuk Ujian Tempatan

Jika anda ingin menguji kod webhook anda secara tempatan, yang lazimnya berada pada alamat http, anda boleh menggunakan URL proksi webhook untuk memajukan webhooks ke komputer atau codespace anda. Di bawah ialah langkah yang disyorkan menggunakan smee.io, tetapi anda boleh menggunakan sebarang perkhidmatan yang anda inginkan untuk menjana URL proksi webhook.

Dapatkan URL proksi webhook:

  1. Dalam pelayar anda, pergi ke https://smee.io/
  2. Klik "Start a new channel"
  3. Salin URL penuh di bawah "Webhook Proxy URL". Anda akan menggunakan URL ini dalam langkah persediaan berikut.

Majukan webhooks:

  1. Jika anda belum memasang smee-client, jalankan perintah berikut dalam terminal anda.
npm install --global smee-client
  1. Untuk menerima webhooks yang dimajukan daripada smee.io, jalankan perintah berikut dalam terminal anda. Gantikan WEBHOOK_PROXY_URL dengan URL proksi webhook anda dari sebelumnya.
smee --url WEBHOOK_PROXY_URL --path /webhook --port 3000

Anda sepatutnya melihat output yang kelihatan seperti ini, dengan WEBHOOK_PROXY_URL ialah URL proksi webhook anda:

Forwarding WEBHOOK_PROXY_URL to http://127.0.0.1:3000/webhook
Connected WEBHOOK_PROXY_URL
  1. Biarkan ini berjalan semasa anda menguji webhook anda. Apabila anda ingin menghentikan pemajuan webhooks, masukkan Ctrl+C.
    Perhatikan bahawa laluan ialah /webhook dan port ialah 3000. Nilai ini mungkin berguna apabila anda ingin menyediakan kod anda sendiri untuk menerima penghantaran webhook kemudian.

Cipta webhook:

Anda kini boleh menggunakan URL proksi webhook untuk mencipta webhook baharu dalam halaman tetapan Meshy API.

Respons Contoh

Apabila status tugasan berubah, Meshy akan POST payload webhook ke URL yang anda konfigurasikan. Payload mengandungi objek tugasan dalam format JSON. Untuk penerangan lengkap tentang semua sifat objek tugasan dan payload contoh, lihat: