ຄູ່ມືການປະຕິບັດ Webhook
ລົງທະບຽນ URL ແບບ HTTPS ແລະ ຮັບການສົ່ງເຫດການແບບ Real-Time ທີ່ຖືກລົງນາມໂດຍ HMAC ເມື່ອສັນຍານ Smart Money ເກີດຂຶ້ນ — ບໍ່ຕ້ອງ polling. ຄູ່ມືນີ້ຄຸ້ມຄອງການລົງທະບຽນ, ການກັ່ນຕອງເຫດການ, ການຢືນຢັນລາຍເຊັນ, ແລະ ພຶດຕິກຳການລອງໃໝ່.
ພາບລວມ
ແທນທີ່ຈະ polling /v1/confirm ຫຼື ຟີດສັນຍານ, ລົງທະບຽນ webhook ແລະ Smart Money API ຈະ POST ເຫດການໄປຫາ endpoint ຂອງທ່ານໃນທັນທີທີ່ສັນຍານທີ່ກົງກັນເກີດຂຶ້ນ. ທຸກໆການສົ່ງຈະຖືກລົງນາມໂດຍ HMAC-SHA256 ເພື່ອໃຫ້ທ່ານສາມາດຢືນຢັນວ່າມັນມາຈາກເຮົາຈິງ.
Webhooks ຂາເອົາເປັນມີໃຫ້ໃນແຜນ Pro ແລະ Enterprise.
ລົງທະບຽນ Webhook
POST ໄປຫາ /v1/webhooks ພ້ອມກັບ API key ຂອງທ່ານໃນ X-API-Key ຫົວຂໍ້. ຕ້ອງມີສີ່ຟິວດ້ານໃນ body:
| ຟິວ | ປະເພດ | ຄຳອະທິບາຍ |
|---|---|---|
| url | string | Endpoint HTTPS ເພື່ອຮັບເຫດການ (ຕ້ອງເລີ່ມຕົ້ນດ້ວຍ https://) |
| events | array | ຊື່ເຫດການທີ່ຈະຮັບ, ຕົວຢ່າງ ["HIGH","MEDIUM","VETO"] ຫຼື ["*"] |
| symbols | array | ສັນຍາລັກທີ່ຈະກັ່ນຕອງ, ຕົວຢ່າງ ["BTC","ETH"] ຫຼື ["*"] |
| secret | string | ລະຫັດລັບການລົງນາມຂອງທ່ານ — ຢ່າງໜ້ອຍ 16 ຕົວອັກສອນ. ຈະຖືກເກັບໄວ້ໃນຮູບແບບ hashed; ເກັບຄ່າດັ້ງເດີມໄວ້ທາງຝ່າຍທ່ານເພື່ອຢືນຢັນລາຍເຊັນ. |
ຕົວກັ່ນຕອງເຫດການ
ການສົ່ງຈະເກີດຂຶ້ນສຳລັບເຫດການທີ່ຊື່ແລະສັນຍາລັກກົງກັບການລົງທະບຽນຂອງທ່ານ. ຊື່ເຫດການທົ່ວໄປແມ່ນກຸ່ມຄວາມໝັ້ນໃຈການຢືນຢັນ — HIGH, MEDIUM, VETO — ບວກກັບເຫດການທົ່ວໄປ SIGNAL . ໃຊ້ ["*"] ເພື່ອຮັບເຫດການທັງໝົດຫຼືສັນຍາລັກທັງໝົດ.
ການສົ່ງ & ຫົວຂໍ້
ແຕ່ລະຄັ້ງສົ່ງແມ່ນ HTTP POST ພ້ອມກັບ body ແບບ JSON ແລະຫົວຂໍ້ເຫຼົ່ານີ້:
| Header | Value |
|---|---|
| X-SmartMoney-Event | ຊື່ຂອງເຫດການ (ຕົວຢ່າງ HIGH) |
| X-SmartMoney-Signature | HMAC-SHA256 hex digest ຂອງຮ່າງຂໍ້ຄວາມ (ເບິ່ງຂ້າງລຸ່ມ) |
| Content-Type | application/json |
| User-Agent | SmartMoneyAPI-Webhook/1.0 |
ຕອບກັບດ້ວຍສະຖານະໃດ 2xx ການຕອບສະຫນອງທີ່ບໍ່ແມ່ນ 2xx (ຫຼືການຫວ່າງເວລາ) ຈະເຮັດໃຫ້ມີການລອງໃໝ້ອີກຄັ້ງ.
ການກວດສອບລາຍເຊັນ
ລາຍເຊັນໃນ X-SmartMoney-Signature ແມ່ນ HMAC-SHA256 hex digest ຂອງຮ່າງຂໍ້ຄວາມ. ຄີ HMAC ແມ່ນ SHA-256 hex digest ຂອງຄວາມລັບທີ່ທ່ານລົງທະບຽນ (ຄວາມລັບດິບຂອງທ່ານຈະຖືກເກັບໄວ້ເປັນຮາຊ໌ເທົ່ານັ້ນໃນຝ່າຍຂອງພວກເຮົາ). ເພື່ອກວດສອບ: ສ້າງຄີ, HMAC ຮ່າງຂໍ້ຄວາມດິບ, ແລະປຽບທຽບດ້ວຍການກວດສອບເວລາຄົງທີ່. ປະຕິເສດການຮ້ອງຂໍໃດໆທີ່ລົ້ມເຫລວ.
ການລອງໃໝ້
ຖ້າ endpoint ຂອງທ່ານບໍ່ຕອບສະຫນອງດ້ວຍ 2xx (ຫຼືຫວ່າງເວລາ — ເວລາສົ່ງແມ່ນ 10s), Smart Money API ຈະລອງໃໝ້ອີກສູງສຸດ 3 ຄັ້ງດ້ວຍ exponential backoff (ປະມານ 1s, 4s, ຈາກນັ້ນ 16s). ເຮັດໃຫ້ handler ຂອງທ່ານເປັນ idempotent ເພື່ອໃຫ້ການສົ່ງໃໝ້ອີກຄັ້ງປອດໄພທີ່ຈະປະມວນຜົນສອງຄັ້ງ.
Inbound Webhooks (TradingView)
ຕ່າງຫາກ, ທ່ານສາມາດສົ່ງ inbound ການແຈ້ງເຕືອນມາຫາພວກເຮົາ. POST /v1/tradingview/webhook ຮັບການແຈ້ງເຕືອນຈາກ TradingView, ປະມວນຜົນຜ່ານ /confirm, ແລະ ສົ່ງການຢືນຢັນກັບມາ. ເນື່ອງຈາກ TradingView ບໍ່ສາມາດສົ່ງ header ທີ່ກຳນົດເອງ, ມັນຈະກວດສອບຜ່ານ secret ຟິວໃນຮ່າງຂໍ້ຄວາມ JSON (ບໍ່ແມ່ນ X-API-Key). ສົ່ງ secret, symbol, ແລະ direction (long/short); ທາງເລືອກ timeframe, strategy, ແລະ price.
ພ້ອມທີ່ຈະເຊື່ອມຕໍ່ສັນຍານເວລາຈິງ?
ເອົາຄີ API ຂອງທ່ານ