Bitculator

นโยบาย

นโยบาย API

Data API กำหนดเวอร์ชันอย่างไร การเลิกใช้ประกาศอย่างไรและกินเวลานานเท่าใด และจะรายงานปัญหาด้านความปลอดภัยได้อย่างไร

การกำหนดเวอร์ชัน

API กำหนดเวอร์ชันไว้ในพาธ: ทุก endpoint อยู่ภายใต้ /api/v1 ค่า info.version ของสัญญา (ปัจจุบันคือ 1.3.1) เป็นไปตามบันทึกการเปลี่ยนแปลง คือ หมายเลข minor จะเพิ่มขึ้นเมื่อมีการเพิ่มสิ่งใหม่ หมายเลข patch จะเพิ่มขึ้นเมื่อมีการแก้ไข และเวอร์ชันพาธใหม่ (/api/v2) เป็นหนทางเดียวที่การเปลี่ยนแปลงซึ่งทำให้ใช้งานไม่ได้จะถูกปล่อยออกมา

SDK อย่างเป็นทางการทั้งแปดตัวจะตาม API อยู่เสมอ โดย endpoint ใหม่คือการปล่อย SDK เวอร์ชัน minor ส่วน endpoint ที่ถูกนำออกหรือเปลี่ยนชื่อคือเวอร์ชัน major

อะไรนับเป็นการเปลี่ยนแปลงที่ทำให้ใช้งานไม่ได้

สิ่งต่อไปนี้จะไม่เกิดขึ้นภายในเวอร์ชันพาธเดียวกัน:

  • การนำออกหรือเปลี่ยนชื่อ endpoint พารามิเตอร์ในคิวรี หรือฟิลด์ในการตอบกลับ
  • การเปลี่ยนชนิดข้อมูลของฟิลด์ หรือกฎที่ว่าราคา อัตรา และอุปทานเป็นสตริงทศนิยม
  • การเปลี่ยน envelope { data, meta } envelope ของข้อผิดพลาด หรือความหมายของรหัสข้อผิดพลาดที่มีอยู่เดิม
  • การลดขีดจำกัดอัตราหรือโควตาที่แพ็กเกจหนึ่งมีอยู่แล้ว

สิ่งต่อไปนี้เกิดขึ้นได้ทุกเมื่อ และจะประกาศไว้ในบันทึกการเปลี่ยนแปลง:

  • endpoint พารามิเตอร์ในคิวรี และฟิลด์ในการตอบกลับที่เพิ่มเข้ามาใหม่
  • รหัสข้อผิดพลาดใหม่สำหรับสถานการณ์ใหม่ - ให้เทียบกับ error.code เสมอ อย่าเทียบกับข้อความ
  • ค่าใหม่ในรายการที่เอกสารอ้างอิงระบุว่าอาจเพิ่มขึ้นได้ เช่น ชื่อเหตุการณ์และชื่ออินดิเคเตอร์
  • ขีดจำกัดและโควตาที่สูงขึ้น

การเลิกใช้

เมื่อ endpoint พารามิเตอร์ หรือฟิลด์ใดถูกกำหนดให้นำออก จะมีการประกาศในบันทึกการเปลี่ยนแปลงและส่งอีเมลถึงเจ้าของคีย์ทุกคน และตั้งแต่วันนั้น endpoint จะตอบกลับพร้อมเฮดเดอร์ Deprecation และ Sunset (RFC 9745, RFC 8594) ที่ระบุวันที่นำออก ส่วนสัญญา OpenAPI จะกำกับไว้ด้วย deprecated: true

การนำออกจะเกิดขึ้นไม่เร็วกว่าหกเดือนหลังการประกาศ เวอร์ชันพาธใหม่จะทำงานคู่ขนานกับเวอร์ชันก่อนหน้าอย่างน้อยหกเดือน ก่อนที่เวอร์ชันเก่าจะถูกยุติด้วยวิธีเดียวกัน

ขณะนี้ไม่มีสิ่งใดถูกเลิกใช้หรือกำหนดให้นำออก

ขีดจำกัดและการใช้งานที่เป็นธรรม

ขีดจำกัดแบบเบิร์สต์ต่อนาทีและโควตารายเดือนเป็นส่วนหนึ่งของแพ็กเกจคุณ โดยรายงานไว้ในทุกการตอบกลับผ่านเฮดเดอร์ X-RateLimit-* และ X-Quota-* และมีบันทึกไว้ในเอกสารอ้างอิง การเพิ่มขีดจำกัดไม่ถือว่าทำให้ใช้งานไม่ได้ แต่การลดขีดจำกัดภายในแพ็กเกจถือว่าใช่ และจะเป็นไปตามกำหนดเวลาของการเลิกใช้

การเปิดเผยช่องโหว่อย่างรับผิดชอบ

หากคุณเชื่อว่าพบช่องโหว่ด้านความปลอดภัยใน bitculator.com, Data API, เซิร์ฟเวอร์ MCP หรือ SDK กรุณาส่งอีเมลถึง contact@bitculator.com พร้อมระบุ URL หรือ endpoint ที่ได้รับผลกระทบ ขั้นตอนการทำซ้ำ และผลกระทบที่คุณเห็น คุณจะได้รับการตอบกลับภายในสามวันทำการ

กรุณาเก็บรายงานไว้เป็นความลับจนกว่าจะได้รับการแก้ไข อย่าเข้าถึงหรือแก้ไขข้อมูลที่ไม่ใช่ของคุณ และอย่ารันการโจมตีแบบปฏิเสธการให้บริการหรือการสแกนอัตโนมัติกับระบบจริง รายงานที่ทำโดยสุจริตภายใต้เงื่อนไขเหล่านี้จะไม่ถูกดำเนินคดีทางกฎหมาย เราไม่มีโครงการจ่ายเงินรางวัล แต่ให้เครดิตได้ตามที่ร้องขอ

ข้อมูลติดต่อเดียวกันนี้เผยแพร่ในรูปแบบที่เครื่องอ่านได้ที่ /.well-known/security.txt (RFC 9116)

สถานะและเหตุขัดข้อง

สถานะของส่วนประกอบแบบสด เหตุขัดข้องที่ยังเปิดอยู่ และการหยุดให้บริการในช่วง 30 วันล่าสุด อยู่ที่หน้าสถานะ และที่ /status.json