Skip to content

คู่มืออ้างอิง API ​

Rate Limits ​

ทุกการตอบกลับจาก API จะแนบ header เหล่านี้มาด้วย เพื่อช่วยให้คุณติดตามและใช้งานให้อยู่ภายใต้ rate limit:

Headerคำอธิบาย
x-rate-limit-limitระยะเวลาของช่วง rate limit ปัจจุบัน (เช่น 1m)
x-rate-limit-remainingจำนวนคำขอที่เหลืออยู่ในช่วงเวลาปัจจุบัน
x-rate-limit-resetเวลาแบบ ISO 8601 ที่ช่วง rate limit ปัจจุบันจะรีเซ็ตใหม่

ขีดจำกัดการใช้งาน ​

Endpointขีดจำกัด
/search7 คำขอต่อ 5 วินาที
/:category200 คำขอต่อนาที (แยกตามแต่ละหมวดหมู่)
/:category/:filename.:format200 คำขอต่อนาที (ใช้โควตาร่วมกันทั้งไฟล์ .png และ .gif)

User-Agent ​

แม้จะไม่ได้บังคับให้ตั้งค่า User-Agent header แบบกำหนดเอง แต่เราแนะนำให้ระบุไว้ในทุกคำขอตามรูปแบบ: APP_NAME (CONTACT_INFO)
เช่น NekoApp (https://example.com) หรือ NekoApp (dev@example.com)

แนวทางการตั้งชื่อที่แนะนำ:

  • ระบุให้ชัดเจน: ใช้ชื่อจริงของแอปพลิเคชัน แทนชื่อทั่วไปอย่าง "Discord Bot", "WhatsApp Bot" หรือ "Telegram Bot"
  • หลีกเลี่ยงค่าสมมติ: อย่าใช้คำจำลองอย่าง test, bot หรือคัดลอกค่าตัวอย่างด้านบนไปใช้ตรงๆ
  • หลีกเลี่ยงค่าเริ่มต้นของไลบรารี: ควรกำหนดค่าเองแทนค่าดีฟอลต์อย่าง python-requests, okhttp, axios, node หรือ Go-http-client

ตัวเลือกสำหรับข้อมูลติดต่อ:
ข้อมูลติดต่อไม่จำเป็นต้องเป็นเว็บไซต์เสมอไป สามารถใช้สิ่งเหล่านี้แทนได้:

  • อีเมลติดต่อโดยตรง
  • เว็บไซต์โปรเจกต์ หรือ URL ของ repository แบบสาธารณะ (เช่น GitHub, GitLab)
  • ลิงก์เชิญบอท หรือหน้าแนะนำบอท
  • ลิงก์หน้ารายการบอท (เช่น top.gg หรือไดเรกทอรีที่คล้ายกัน)

การปลอมแปลงและแอบอ้าง:

  • ห้ามปลอมแปลงสตริงของเบราว์เซอร์ รูปแบบ Mozilla/5.0 ... สงวนไว้สำหรับเว็บเบราว์เซอร์จริงและบอทที่ผ่านการยืนยันจาก Cloudflare เท่านั้น
  • ห้ามแอบอ้างเป็น crawler ที่รู้จักกันทั่วไป เช่น Googlebot หรือ Bingbot

INFO

การไม่ตั้งค่า User-Agent header แบบกำหนดเองอาจเพิ่มความเสี่ยงในการถูกตรวจจับหรือแบนโดยระบบป้องกันการใช้งานผิดวัตถุประสงค์อัตโนมัติของเรา (NB-BCFSD)

หมวดหมู่ ​

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

รูปภาพ (4) ​

husbandokitsunenekowaifu

GIF (59) ​

angrybakabiteblehblowkissblushbonkboredcarryclapconfusedcrycuddledancefacepalmfeedhandholdhandshakehappyhighfivehugkabedonkickkisslappillowlaughlurknodnomnopenyapatpeckpokepoutpunchrunsaluteshakeshootshockedshrugsipslapsleepsmilesmugspinstaretableflipteeheethinkthumbsupticklewagwavewinkyawnyeet

ฟิลด์ในการตอบกลับ ​

ประเภทฟิลด์
รูปภาพartist_name, artist_href, source_url
GIFanime_name

ทั้งสองประเภทจะมีฟิลด์ url และ dimensions รวมอยู่ด้วยเสมอ