Pesanan anda, dalam alat anda sendiri.
Dengan Grow anda boleh cipta kunci API baca sahaja untuk menarik pesanan, produk dan inventori ke dalam laporan anda sendiri, dan hantar peristiwa pesanan bertandatangan ke pelayan anda apabila pesanan dibayar, dihantar, diterima, dibatalkan atau dibayar balik.
Dapatkan Grow- 5
- kunci API baca sahaja yang aktif
- 60 / min
- permintaan dibenarkan bagi setiap kunci
- 5 peristiwa
- dibayar, dihantar, diterima, dibatalkan dan dibayar balik
- 30 hari
- penghantaran webhook berjaya disimpan dalam log penghantaran webhook
01 — Kunci API
Baca data anda dengan kunci.
Cipta sehingga lima kunci baca sahaja di Tetapan → Integrasi. Tandakan akses bagi setiap kunci: pesanan, produk atau inventori. Kunci hanya dipaparkan sekali, jadi salin ketika itu; jika hilang, batalkannya dan cipta yang baharu. Panggil GET /api/v1/orders, /api/v1/products atau /api/v1/inventory dengan kunci sebagai token Bearer. Respons ialah JSON, 50 item sehalaman secara lalai (sehingga 100) dengan kursor untuk halaman seterusnya, dan setiap kunci boleh membuat 60 permintaan seminit. Membatalkan kunci, atau Grow tamat, menghentikan akses.
- Sehingga 5 kunci aktif, setiap satu dengan aksesnya sendiri
- GET sahaja: pesanan, produk, inventori
- 50 sehalaman, sehingga 100; 60 permintaan seminit
GET /api/v1/orders?limit=50Authorization: Bearer jjk_…{ "data": [ … ], "nextCursor": "…" }Salin kunci ini sekarang. Ia tidak akan dipaparkan lagi.
Data contoh untuk ilustrasi
02 — Webhook
Tahu bila pesanan berubah.
Tambah titik akhir HTTPS di Tetapan → Integrasi → Webhook pesanan dan pilih peristiwa: order.paid, order.shipped, order.delivered, order.cancelled dan order.refunded. Setiap penghantaran webhook ialah muatan JSON dengan peristiwa, kunci peristiwa yang unik, bila ia berlaku dan petikan pesanan: item, jumlah dalam sen, status, butiran pembeli dan penghantaran. Hantar ujian dahulu. Penghantaran webhook disusun dalam giliran dan dihantar setiap beberapa minit, jadi jangkakan ia sampai dalam masa beberapa minit selepas pesanan berubah.
- Lima peristiwa pesanan
- Titik akhir HTTPS sahaja
- Hantar peristiwa ujian sebelum anda bergantung padanya
{ "event": "order.paid", "event_key": "…", "occurred_at": "…", "order": { … } }Penghantaran webhook disusun dalam giliran dan dihantar setiap beberapa minit.
Data contoh untuk ilustrasi
03 — Sahkan
Pastikan setiap permintaan memang daripada kami.
Setiap permintaan membawa pengepala X-JomJual-Signature: cap masa dan tandatangan HMAC-SHA256 bagi cap masa, satu titik dan badan permintaan mentah, dibuat dengan rahsia tandatangan titik akhir anda (dipaparkan sekali, semasa anda mencipta titik akhir). Kira semula di pihak anda, bandingkan dalam masa malar dan tolak cap masa yang lebih lama daripada lima minit. X-JomJual-Event-Id ialah kunci unik bagi setiap peristiwa. Penghantaran webhook ialah sekurang-kurangnya sekali, jadi gunakannya untuk mengabaikan ulangan. Balas dengan mana-mana 2xx dalam sepuluh saat.
- HMAC-SHA256 dengan rahsia tandatangan anda
- Tolak cap masa lebih lama daripada lima minit
- Nyahganda berdasarkan X-JomJual-Event-Id
X-JomJual-Signature: t=1760000000,v1=9f2c…- Kira semula HMACCap masa, satu titik, kemudian badan mentah, dengan rahsia anda1
- Bandingkan dalam masa malarTolak permintaan jika tidak sepadan2
- Semak cap masaTolak apa-apa yang lebih lama daripada lima minit3
- Langkau ulanganNyahganda berdasarkan X-JomJual-Event-Id4
Data contoh untuk ilustrasi
04 — Cuba semula
Cuba semula, hantar semula dan log.
Jika titik akhir anda tidak menjawab dengan 2xx dalam sepuluh saat, JomJual mencuba semula selepas 1 minit, 5 minit, 30 minit, 2 jam dan 6 jam, kemudian setiap hari. Ia tidak mematikan titik akhir anda. Log penghantaran webhook menunjukkan status, bilangan percubaan dan respons setiap penghantaran webhook, dan Hantar semula menghantar satu lagi. Penghantaran webhook yang berjaya disimpan sehingga 30 hari, sehingga 1,000 bagi setiap titik akhir.
- Cuba semula pada 1m, 5m, 30m, 2j, 6j, kemudian setiap hari
- Hantar semula mana-mana penghantaran webhook dari log
- Titik akhir tidak pernah dimatikan kerana gagal
- order.paid1 percubaan · 200dihantar
- order.shipped2 percubaan · 503menunggu
- order.delivered1 percubaan · 200dihantar
Hantar semula menghantar mana-mana penghantaran webhook sekali lagi.
Data contoh untuk ilustrasi
Kenapa peniaga beralih
Sebelum
Salin-tampal pesanan
- Eksport pesanan secara manual
- Semak papan pemuka untuk pesanan baharu
- Taip semula butiran pesanan ke alat lain
Dengan JomJual
Pesanan yang sampai ke alat anda
- API baca sahaja untuk laporan anda
- Webhook bertandatangan apabila pesanan berubah
- Cuba semula dan log penghantaran webhook
Soalan yang peniaga tanya.
Adakah ini termasuk dalam Grow?
Ya. Kunci API dan webhook pesanan adalah sebahagian daripada Grow. Jika Grow tamat, akses API terhenti.
Boleh API mengubah apa-apa?
Tidak. Kunci adalah baca sahaja dan API hanya menjawab permintaan GET.
Berapa cepat webhook dihantar?
Penghantaran webhook disusun dalam giliran dan dihantar setiap beberapa minit, jadi jangkakan ia sampai dalam masa beberapa minit selepas pesanan berubah.
Bagaimana jika pelayan saya mati?
JomJual mencuba semula selepas 1 minit, 5 minit, 30 minit, 2 jam dan 6 jam, kemudian setiap hari, dan tidak mematikan titik akhir anda. Anda juga boleh menghantar semula mana-mana penghantaran webhook dari log.
Boleh saya terima peristiwa yang sama dua kali?
Boleh, penghantaran webhook ialah sekurang-kurangnya sekali. Setiap peristiwa ada kunci unik dalam X-JomJual-Event-Id dan event_key, jadi abaikan kunci yang sudah anda kendalikan.
Siapa yang boleh menyediakannya?
Pemilik kedai, di Tetapan → Integrasi.