คู่มือ

เริ่มต้นใช้งาน Nubbo API

จากศูนย์สู่คำขอแรกของคุณในไม่กี่นาที สร้างคีย์แล้วเริ่มจัดการพื้นที่เก็บข้อมูลจากโค้ดของคุณเอง

Nubbo API เป็น REST API สำหรับทำงานกับบัคเก็ตของคุณจากโค้ดของคุณเอง ได้แก่ ไฟล์ โฟลเดอร์ ลิงก์ คำขอไฟล์ แกลเลอรี ป้ายกำกับ โปรเจกต์ และระบบอัตโนมัติ ในคู่มือนี้คุณจะสร้างคีย์และส่งคำขอแรกด้วย curl

สิ่งที่คุณจะได้รับ

  • จัดการพื้นที่ Nubbo จากโปรแกรมของคุณ ด้วยคีย์ที่เห็นเฉพาะสิ่งที่คุณเลือก
  • อัปโหลดและดาวน์โหลดโดยตรงระหว่างโค้ดของคุณกับผู้ให้บริการพื้นที่จัดเก็บ
  • ตอบสนองต่อไฟล์ใหม่ การอัปโหลดเข้าคำขอไฟล์ และกิจกรรมด้วยทริกเกอร์

ก่อนเริ่มต้น

คุณต้องมีบัญชี Nubbo ในแผน Pro หรือ ทีม และเทอร์มินัลที่มี curl ในทีม เจ้าของหรือผู้ดูแลเป็นผู้สร้างคีย์ API

ขั้นตอนที่ 1: สร้างคีย์

  1. ใน Nubbo เปิด การตั้งค่า › API (หรือ ทีม › API หากอยู่ในทีม) แล้วกด สร้างคีย์ API

  2. ตั้งชื่อและเลือก:

    • สิทธิ์: อ่านอย่างเดียว หรือ อ่านและเขียน
    • ขอบเขต: ทั้งพื้นที่ หรือ บัคเก็ตและโปรเจกต์ที่เลือก คีย์จะเห็นเฉพาะสิ่งที่คุณเลือกที่นี่
    • วันหมดอายุ: 30 วัน 90 วัน 1 ปี หรือ ไม่มีวันหมดอายุ Nubbo จะเตือนคุณล่วงหน้า 7 วัน

    กด สร้างคีย์ Nubbo จะขอรหัสผ่านเพื่อยืนยันว่าเป็นคุณ หากคุณเปิดการยืนยันตัวตนสองขั้นตอนไว้ Nubbo จะขอรหัสยืนยันด้วย

    หน้าต่างสร้างคีย์ API พร้อมสิทธิ์ ขอบเขต และวันหมดอายุ หน้าต่างสร้างคีย์ API พร้อมสิทธิ์ ขอบเขต และวันหมดอายุ
  3. คัดลอกคีย์แล้วกด บันทึกไว้แล้ว คีย์ขึ้นต้นด้วย nbk_ และนี่เป็นครั้งเดียวที่คุณจะเห็นคีย์แบบเต็ม เก็บคีย์ไว้บนเซิร์ฟเวอร์หรือในเครื่องมือที่จะใช้งาน ห้ามเก็บไว้ในหน้าเว็บ

    หน้าต่างคีย์ API ของคุณพร้อมคีย์ที่พร้อมให้คัดลอก หน้าต่างคีย์ API ของคุณพร้อมคีย์ที่พร้อมให้คัดลอก

ขั้นตอนที่ 2: คำขอแรกของคุณ

ส่งคีย์ในส่วนหัว Authorization ของทุกคำขอ เริ่มด้วย GET /v1/me ซึ่งไม่นับเป็นคำขอ:

curl https://api.nubbo.app/v1/me \
  -H "Authorization: Bearer nbk_your_key"

คำตอบจะมีพื้นที่ แผน โควตาของเดือน และคีย์พร้อมสิทธิ์และขอบเขตของคีย์ นี่คือตัวอย่างบางส่วน:

{
  "workspace": { "id": "…", "name": "สตูดิโอเหนือ", "kind": "PERSONAL" },
  "plan": "PRO",
  "key": {
    "name": "คีย์แรกของฉัน",
    "prefix": "nbk_3jKF3m",
    "access": "READ",
    "allResources": true
  },
  "quota": {
    "requests": { "used": 0, "limit": 50000, "remaining": 50000 },
    "events": { "used": 0, "limit": 20000, "remaining": 20000 },
    "ratePerMinute": 60
  }
}

จากนั้นแสดงรายการบัคเก็ตและไฟล์ในโฟลเดอร์:

curl https://api.nubbo.app/v1/buckets \
  -H "Authorization: Bearer nbk_your_key"

curl "https://api.nubbo.app/v1/buckets/<bucketId>/files?prefix=invoices/" \
  -H "Authorization: Bearer nbk_your_key"

รายการจะส่งกลับ data และ nextCursor สำหรับหน้าถัดไป ให้ส่งค่านั้นใน cursor เมื่อ nextCursor เป็น null แสดงว่าไม่มีข้อมูลเพิ่มแล้ว

เทอร์มินัลพร้อมคำขอ GET /v1/me และคำตอบ เทอร์มินัลพร้อมคำขอ GET /v1/me และคำตอบ

ขั้นตอนที่ 3: เอกสารอ้างอิง

ใน การตั้งค่า › API กด ดูเอกสาร หรือเปิด api.nubbo.app/v1/docs ทุกทรัพยากรอยู่ที่นั่นพร้อมฟิลด์และตัวอย่าง เอกสาร OpenAPI อยู่ที่ api.nubbo.app/v1/openapi.json

เอกสารอ้างอิง Nubbo API พร้อมตัวอย่าง curl เอกสารอ้างอิง Nubbo API พร้อมตัวอย่าง curl

การอัปโหลดและดาวน์โหลด

ไฟล์ไม่ผ่าน Nubbo หากต้องการอัปโหลดไฟล์ ให้เริ่มการอัปโหลดด้วย POST /v1/buckets/{bucketId}/uploads ส่งไฟล์ไปยังที่อยู่แบบ presigned ที่ได้รับกลับมา แล้วปิดท้ายด้วย POST /v1/uploads/{uploadId}/complete หากต้องการดาวน์โหลด ให้ขอลิงก์ด้วย POST /v1/files/{fileId}/download-link แล้วดาวน์โหลดจากผู้ให้บริการของคุณ

ขีดจำกัด

Proทีม
คำขอต่อนาทีต่อคีย์60120
คำขอต่อเดือน50,000100,000 + 10,000 ต่อที่นั่ง
เหตุการณ์ของทริกเกอร์ต่อเดือน20,00050,000 + 5,000 ต่อที่นั่ง

โควตาเป็นของพื้นที่และรีเซ็ตทุกรอบการเรียกเก็บเงิน GET /v1/me การตรวจสอบของทริกเกอร์ และคำตอบ 401, 429 และ 5xx ไม่นับเป็นคำขอ ทุกเหตุการณ์ที่ทริกเกอร์ส่งมานับเป็นเหตุการณ์ ทุกคำตอบมีส่วนหัว X-RateLimit-Remaining และ X-Nubbo-Quota-Requests-Remaining และคุณดูการใช้งานของรอบได้ใน การตั้งค่า › API

การใช้งาน API ของรอบในการตั้งค่า Nubbo การใช้งาน API ของรอบในการตั้งค่า Nubbo

หากเกิดปัญหา

  • API_KEY_INVALID, API_KEY_REVOKED หรือ API_KEY_EXPIRED: คีย์ไม่ถูกต้อง ถูกเพิกถอน หรือหมดอายุแล้ว ตรวจสอบส่วนหัวหรือสร้างคีย์ใหม่
  • API_PLAN_REQUIRED: พื้นที่ของคีย์ไม่มี API ซึ่งมีในแผน Pro และ ทีม
  • API_KEY_READ_ONLY: คีย์เป็นแบบอ่านอย่างเดียว สร้างคีย์ใหม่ด้วย อ่านและเขียน
  • API_RATE_LIMITED: มีคำขอจากคีย์นี้มากเกินไป รอตามจำนวนวินาทีใน Retry-After แล้วลองอีกครั้ง
  • API_QUOTA_EXCEEDED: พื้นที่ใช้ขีดจำกัดรายเดือนครบแล้ว details.resetsAt บอกว่าจะรีเซ็ตเมื่อใด

ทุกข้อผิดพลาดมี requestId ใส่ไว้ด้วยหากคุณติดต่อเรา

ดูเพิ่มเติมเกี่ยวกับ Nubbo API หากต้องการใช้โดยไม่ต้องเขียนโค้ด ให้ทำตามคู่มือ Zapier n8n หรือ Make หากต้องการใช้จากผู้ช่วย AI ดูวิธี เชื่อมต่อ Nubbo กับ Claude, ChatGPT หรือ Cursor

คำถามที่พบบ่อย

แผนใดบ้างที่มี API?

Pro และ ทีม ในแผนฟรีหรือ Personal คำขอจะได้รับคำตอบ API_PLAN_REQUIRED

อ่านไฟล์ที่เข้ารหัสด้วย API ได้ไหม?

ไม่ได้ รายการที่เข้ารหัสจะแสดงโดยไม่มีชื่อ เส้นทาง ขนาด และประเภท และการเปลี่ยนแปลงใดๆ จะถูกปฏิเสธด้วย API_ENCRYPTED_CONTENT

จะเกิดอะไรขึ้นหากส่งคำขอซ้ำเพราะเครือข่ายขัดข้อง?

ส่งส่วนหัว Idempotency-Key ในคำขอ POST และ PATCH ภายใน 24 ชั่วโมง การส่งคำขอเดิมซ้ำจะได้คำตอบแรกกลับมาและไม่สร้างสิ่งใดซ้ำสองครั้ง

API จะเปลี่ยนโดยไม่แจ้งล่วงหน้าไหม?

ไม่ การเปลี่ยนแปลงที่ทำให้ของเดิมใช้ไม่ได้จะออกเป็น /v2 และ /v1 จะยังอยู่อย่างน้อย 12 เดือนพร้อมส่วนหัว Deprecation และ Sunset

แหล่งที่มา

ตรวจสอบขั้นตอนกับหน้าเหล่านี้แล้ว