v0.2.3-beta
เข้าสู่ระบบ register

brainful ไลบรารี API

การนำทางแบบรวดเร็ว

ภาพรวม การเริ่มต้น การยืนยันตัวตน สร้างบล็อก เพิ่มลงในบล็อก ดึงข้อมูลบล็อก ได้รับแรงบันดาลใจ

ภาพรวม

ใน brainful API ช่วยให้มีการเชื่อมต่อที่ราบรื่นระหว่างแอปพลิเคชันของคุณและ brainful's ที่ทรงพลัง ระบบจัดการเนื้อหา. ไม่ว่าคุณจะสร้างเครื่องมืออัตโนมัติหรือเชื่อมต่อกับแอปพลิเคชันโปรดของคุณ, ของเรา RESTFUL API มอบวิธีการที่ง่ายและปลอดภัยในการโต้ตอบกับเนื้อหาของคุณ.

คุณสมบัติหลัก

การยืนยันตัวตนที่ปลอดภัย

การยืนยันตัวตนแบบโทเคนพร้อมการเข้ารหัส HTTPS

การออกแบบ RESTful

เมธอด HTTP มาตรฐานพร้อมการตอบสนองแบบ JSON

การสนับสนุนตำแหน่งที่ตั้ง

ความสามารถในการระบุตำแหน่งที่ตั้งภูมิศาสตร์ในตัว

มีข้อจำกัดอัตราการใช้งาน

ปรับปรุงเพื่อประสิทธิภาพที่เชื่อถือได้

กรณีการใช้งาน

การทำงานอัตโนมัติส่วนบุคคล

  • บันทึกโน้ตจากแอปพลิเคชันโปรดของคุณโดยอัตโนมัติ
  • สร้างทริกเกอร์เนื้อหาตามตำแหน่งที่ตั้ง
  • เชื่อมต่อกับ IFTTT/Zapier เวิร์กโฟลว์

โซลูชันการเชื่อมต่อ

  • สร้างการเชื่อมต่อและส่วนขยายแบบกำหนดเอง
  • สร้างเวิร์กโฟลว์เนื้อหาอัตโนมัติ
  • พัฒนา ระบบจัดการเนื้อหา

ข้อกำหนด

ข้อจำกัดอัตราการใช้งาน

60 คำขอต่อนาทีต่อผู้ใช้

การเริ่มต้น

1

รับโทเคน API ของคุณ

ไปที่ brainful หน้าตัวเลือก เพื่อสร้างโทเคน API ของคุณ.

2

เลือกวิธีการเชื่อมต่อของคุณ

เลือกจากโค้ดตัวอย่างของเราใน cURL, JavaScript, หรือ Python เพื่อเริ่มต้นอย่างรวดเร็ว.

3

สร้างคำขอแรกของคุณ

ลองใช้ตัวอย่างแบบโต้ตอบด้านล่างเพื่อทดสอบการเชื่อมต่อของคุณ.

การยืนยันตัวตน

คำขอ API ทั้งหมดต้องการโทเคน API ของคุณในส่วนหัว Authorization รับโทเคนของคุณจาก brainful หน้าตัวเลือก. API รองรับทั้งรูปแบบโทเคนและ bearer token.

Authorization: Token YOUR_API_TOKEN
Authorization: Bearer YOUR_API_TOKEN

สร้างบล็อก

POSThttps://brainful.dev/blocks/add

พารามิเตอร์คำขอ

พารามิเตอร์ทั้งหมดจะถูกส่งในตัวคำขอเป็น JSON.

พารามิเตอร์ประเภทจำเป็นคำอธิบาย
สตริงสตริงใช่เนื้อหาที่จะถูกเพิ่ม (1-5000 ตัวอักษร)
parent_luidสตริงไม่luid ของบล็อกแม่ (ไม่จำเป็น)
latitudeเลขทศนิยมไม่ลินติจูด (-90° ถึง 90°)
longitudeเลขทศนิยมไม่ลองจิจูด (-180° ถึง 180°)
agentสตริงไม่Agent identifier (max 50 chars)
team_spaceสตริงไม่Team space slug to add the block to (only for organization members)

Generated Request

ตัวอย่างการตอบสนอง

{
                    "luid": "abc123",
                    "slug": "My New Block",
                    "type": "thought",
                    "pinned": false,
                    "entities": [],
                    "created_timestamp": "2024-01-01T00:00:00Z",
                    "last_edited": "2024-01-01T00:00:00Z",
                    "experience": 5,
                    "remaining_daily_quota": 97
                  }

ฟิลด์การตอบสนอง

luid

ประเภท: สตริง

ตัวระบุเฉพาะสำหรับเนื้อหาที่สร้างขึ้น

slug

ประเภท: สตริง

URL-friendly version of the content

words

ประเภท: จำนวนเต็ม

Number of words in the content

remaining_daily_quota

ประเภท: จำนวนเต็ม

Remaining content creation quota for today

รหัสการตอบสนอง

201สร้างแล้ว (สําเร็จ)
400คำขอไม่ถูกต้อง (สตริงไม่ถูกต้อง)
401ไม่ได้รับอนุญาต (โทเคนไม่ถูกต้อง)
403Forbidden (plan not sufficient)
422Invalid location coordinates

เพิ่มลงในบล็อก

POSThttps://brainful.dev/blocks/append

พารามิเตอร์คำขอ

พารามิเตอร์ทั้งหมดจะถูกส่งในตัวคำขอเป็น JSON.

พารามิเตอร์ประเภทจำเป็นคำอธิบาย
identifierสตริงใช่ ตัวระบุของบล็อกที่จะเพิ่มเข้าไป (luid หรือ slug)
สตริงสตริงใช่เนื้อหาที่จะถูกเพิ่ม (1-5000 ตัวอักษร)

Generated Request

ตัวอย่างการตอบสนอง

{
  "details": "Text appended to block successfully.",
  "luid": "abc123",
  "slug": "my-example-block"
}

ฟิลด์การตอบสนอง

luid

ประเภท: สตริง

ตัวระบุเฉพาะสำหรับเนื้อหาที่สร้างขึ้น

slug

ประเภท: สตริง

URL-friendly version of the content

words

ประเภท: จำนวนเต็ม

Number of words in the content

remaining_daily_quota

ประเภท: จำนวนเต็ม

Remaining content creation quota for today

รหัสการตอบสนอง

201สร้างแล้ว (สําเร็จ)
400คำขอไม่ถูกต้อง (สตริงไม่ถูกต้อง)
401ไม่ได้รับอนุญาต (โทเคนไม่ถูกต้อง)
403Forbidden (plan not sufficient)

ดึงข้อมูลบล็อก

GEThttps://brainful.dev/blocks/get/{luid}

พารามิเตอร์คำขอ

URL Parameters

พารามิเตอร์ประเภทจำเป็นคำอธิบาย
luidสตริงใช่ตัวระบุเฉพาะของบล็อกที่จะดึงข้อมูล

เนื้อหาคำขอ

พารามิเตอร์ประเภทจำเป็นคำอธิบาย
latitudeเลขทศนิยมไม่ลินติจูด (-90° ถึง 90°)
longitudeเลขทศนิยมไม่ลองจิจูด (-180° ถึง 180°)
agentสตริงไม่ ตัวระบุเอเจนต์ (แม็กซ์ 50 ตัวอักษร)

Generated Request

ตัวอย่างการตอบสนอง

{
  "creator": "johnnyappleseed",
  "luid": "abc123",
  "slug": "My New Block",
  "type": "thought",
  "html": "
My New Block
",
  "blocks": [],
  "entities": [],
  "flagged": false,
  "pinned": false,
  "archived": false,
  "trashed": false,
  "public": false,
  "created_timestamp": "2025-01-28 18:01",
  "last_edited": "2025-01-28 18:01",
  "words": 3,
  "bytes": 45,
  "hits": 0
}

ฟิลด์การตอบสนอง

creator

ประเภท: สตริง

Username of the content creator

luid

ประเภท: สตริง

ตัวระบุเฉพาะสำหรับบล็อก

type

ประเภท: สตริง

ประเภทเนื้อหา (ตัวอย่าง, "thought")

html

ประเภท: สตริง

HTML เนื้อหาของบล็อก

created_timestamp

ประเภท: สตริง

Creation date and time

hits

ประเภท: จำนวนเต็ม

Number of views

รหัสการตอบสนอง

200สําเร็จ (พบบล็อก)
401ไม่ได้รับอนุญาต (โทเคนไม่ถูกต้อง)
403Forbidden (plan not sufficient)
404ไม่พบ (ไม่พบบล็อก)

รู้สึกได้รับแรงบันดาลใจ?

ลองดูการเชื่อมต่ออย่างเป็นทางการของเราที่สร้างด้วย brainful User API ที่นี่!