Webhook
Apabila data syarikat anda berubah, kami menghantar permintaan HTTPS ke setiap titik akhir yang melanggan peristiwa itu. Tambah titik akhir di papan pemuka, di bawah Integrasi.
Permintaan
POST | Dihantar melalui HTTPS ke URL titik akhir yang anda simpan. Ubah hala tidak diikuti. |
|---|---|
Content-Type | Kandungan permintaan ialah peristiwa dalam format JSON, diterangkan di bawah. |
Evd-Signature | Masa permintaan ditandatangani dan tandatangan HMAC-SHA256nya. |
Muatan
Setiap peristiwa menggunakan struktur yang sama. Medan data mengandungi rekod yang terjejas.
{
"event_id": "evt_8KQ2M4ZP7T",
"type": "passport.published",
"created_at": "2026-10-31T02:15:00Z",
"test": false,
"data": {
"product_id": "prd_5F3K9W",
"version": 3,
"state": "PUBLISHED",
"signature_id": "sig_2RT8LQ",
"resolver_url": "https://pass.everdeenone.com/01/09506000134352",
"published_at": "2026-10-31T02:15:00Z",
"withdrawn_at": null
}
}
| Medan | Keterangan |
|---|---|
event_id | Unik bagi setiap peristiwa. Langkau ID yang telah anda proses. |
type | Nama peristiwa, daripada senarai di hujung halaman ini. |
created_at | Masa peristiwa berlaku, dalam UTC. |
test | Bernilai true apabila kunci ujian mencetuskan peristiwa itu. |
data | Rekod yang terjejas, sama seperti yang dipulangkan oleh titik akhir GETnya. |
Sahkan tandatangan
Setiap titik akhir mempunyai rahsia tandatangan sendiri, yang dipaparkan sekali sahaja semasa titik akhir ditambah. Semak setiap permintaan sebelum bertindak:
- Baca t (masa Unix dalam saat) dan v1 daripada pengepala Evd-Signature.
- Kira HMAC-SHA256 dengan rahsia anda ke atas t, satu noktah, dan kandungan permintaan mentah tepat seperti yang diterima.
- Bandingkan hasilnya dengan v1 secara masa tetap.
- Tolak permintaan jika t berbeza lebih daripada lima minit daripada jam anda.
- Langkau ID peristiwa yang telah anda proses, kemudian balas dengan status 2xx.
import crypto from "node:crypto";
// rawBody: the request body as received (a Buffer), before JSON parsing.
export function verify(rawBody, header, secret) {
const parts = Object.fromEntries(
header.split(",").map((p) => [p.slice(0, p.indexOf("=")), p.slice(p.indexOf("=") + 1)]),
);
const t = Number(parts.t);
if (!Number.isInteger(t) || Math.abs(Date.now() / 1000 - t) > 300) return false;
const expected = crypto
.createHmac("sha256", secret)
.update(`${parts.t}.`)
.update(rawBody)
.digest();
const given = Buffer.from(parts.v1 ?? "", "hex");
return given.length === expected.length && crypto.timingSafeEqual(given, expected);
}import hashlib, hmac, time
# raw_body: the request body as received (bytes), before JSON parsing.
def verify(raw_body: bytes, header: str, secret: str) -> bool:
parts = dict(p.split("=", 1) for p in header.split(",") if "=" in p)
t = parts.get("t", "")
if not t.isdigit() or abs(time.time() - int(t)) > 300:
return False
expected = hmac.new(
secret.encode(), t.encode() + b"." + raw_body, hashlib.sha256
).hexdigest()
return hmac.compare_digest(expected, parts.get("v1", ""))// rawBody: the request body as received, before JSON decoding.
func Verify(rawBody []byte, header, secret string) bool {
var t, v1 string
for _, p := range strings.Split(header, ",") {
k, v, _ := strings.Cut(p, "=")
switch k {
case "t":
t = v
case "v1":
v1 = v
}
}
ts, err := strconv.ParseInt(t, 10, 64)
if age := time.Now().Unix() - ts; err != nil || age > 300 || age < -300 {
return false
}
mac := hmac.New(sha256.New, []byte(secret))
mac.Write([]byte(t + "."))
mac.Write(rawBody)
given, err := hex.DecodeString(v1)
return err == nil && hmac.Equal(given, mac.Sum(nil))
}import 'dart:convert';
import 'package:crypto/crypto.dart';
// rawBody: the request body as received, before JSON decoding.
bool verify(List<int> rawBody, String header, String secret) {
final parts = <String, String>{};
for (final p in header.split(',')) {
final i = p.indexOf('=');
if (i > 0) parts[p.substring(0, i)] = p.substring(i + 1);
}
final t = int.tryParse(parts['t'] ?? '');
final now = DateTime.now().millisecondsSinceEpoch ~/ 1000;
if (t == null || (now - t).abs() > 300) return false;
final mac = Hmac(sha256, utf8.encode(secret))
.convert([...utf8.encode('${parts['t']}.'), ...rawBody]);
final expected = mac.toString();
final given = parts['v1'] ?? '';
if (given.length != expected.length) return false;
var diff = 0;
for (var i = 0; i < given.length; i++) {
diff |= given.codeUnitAt(i) ^ expected.codeUnitAt(i);
}
return diff == 0;
}Semak kod anda
Dengan rahsia, cap masa, dan kandungan ini, kod anda patut mengira nilai v1 ini.
secret | example-secret |
|---|---|
t | 1767225600 |
body | {"event_id":"evt_8KQ2M4ZP7T","type":"passport.published"} |
v1 | 21cb13c5a2e80061c64fa3886778905d85dd5b87f2c5ceaa66d88b873dff5b40 |
Cubaan semula dan hantar semula
Balas dengan cepat dan lakukan kerja yang perlahan selepas itu. Respons di luar 2xx, ubah hala, atau tamat masa dikira sebagai cubaan gagal. Kami mencuba semula sehingga 8 kali dalam kira-kira 24 jam, kemudian menandakan penghantaran sebagai gagal. Anda boleh menghantar semula mana-mana penghantaran dari papan pemuka atau API.
Peristiwa
Pilih peristiwa yang diterima oleh setiap titik akhir.
| Peristiwa | Keterangan |
|---|---|
product.created | Produk telah ditambah. |
product.updated | Butiran produk telah berubah. |
item.created | Nombor siri atau lot telah ditambah pada produk. |
item.updated | Nombor siri atau lot telah berubah. |
item.published | Pasport nombor siri atau lot telah mula aktif. |
item.withdrawn | Nombor siri atau lot telah ditarik balik. |
compliance.created | Sijil atau rekod pematuhan telah ditambah. |
compliance.updated | Rekod pematuhan telah berubah. |
document.uploaded | Dokumen telah dimuat naik. |
extraction.completed | Pengekstrakan data daripada dokumen telah selesai. |
review.required | Perubahan sedang menunggu semakan. |
review.approved | Penyemak telah meluluskan perubahan. |
review.rejected | Penyemak telah menolak perubahan. |
passport.published | Pasport produk telah diterbitkan. |
passport.withdrawn | Pasport produk telah ditarik balik. |
certificate.expiring | Sijil akan tamat tempoh dalam 30 hari. |
certificate.expired | Sijil telah tamat tempoh. |