v0.2.3-beta
đăng nhập đăng ký

brainful thư viện API

tổng quan

Cái brainful API cho phép tích hợp liền mạch giữa các ứng dụng của bạn và brainful's mạnh mẽ hệ thống quản lý nội dung. Whether you're building automation tools or integrating with your favorite apps, của chúng tôi API RESTFUL cung cấp cách đơn giản và an toàn để tương tác với nội dung của bạn.

Tính năng chính

Xác thực an toàn

Xác thực dựa trên token với mã hóa https

Thiết kế RESTful

Các phương thức http chuẩn với phản hồi json

Hỗ trợ vị trí

Khả năng định vị địa lý tích hợp sẵn

Giới hạn tốc độ

Tối ưu hóa cho hiệu suất đáng tin cậy

Trường hợp sử dụng

Tự động hóa cá nhân

  • Tự động lưu ghi chú từ những ứng dụng yêu thích của bạn
  • Tạo các kích hoạt nội dung dựa trên vị trí
  • Kết nối với IFTTT/Zapier quy trình làm việc

Giải pháp tích hợp

  • Xây dựng tích hợp và tiện ích mở rộng tùy chỉnh
  • Tạo quy trình nội dung tự động
  • Phát triển hệ thống quản lý nội dung

Yêu cầu

Giới hạn tốc độ

60 yêu cầu mỗi phút mỗi người dùng

Bắt đầu

1

Lấy token API của bạn

Ghé thăm brainful trang tùy chọn để tạo token API của bạn.

2

Chọn phương pháp tích hợp của bạn

Chọn từ mã mẫu của chúng tôi trong cURL, JavaScript, hoặc Python để bắt đầu nhanh chóng.

3

Thực hiện yêu cầu đầu tiên của bạn

Thử các ví dụ tương tác bên dưới để kiểm tra tích hợp của bạn.

xác thực

All API requests require your API token in the Authorization header. Get your token from the brainful trang tùy chọn. API hỗ trợ cả định dạng token và bearer token.

Authorization: Token YOUR_API_TOKEN
Authorization: Bearer YOUR_API_TOKEN

tạo khối

POSThttps://brainful.dev/blocks/add

Tham số yêu cầu

Tất cả tham số được gửi trong phần thân yêu cầu dưới dạng JSON.

Tham sốLoạiBắt buộcMô tả
chuỗichuỗiNội dung cần thêm (1-5000 ký tự)
parent_luidchuỗiKhôngluid của khối cha (tùy chọn)
latitudesố thập phânKhôngvĩ độ (-90° đến 90°)
longitudesố thập phânKhôngkinh độ (-180° đến 180°)
agentchuỗiKhôngAgent identifier (max 50 chars)
team_spacechuỗiKhôngTeam space slug to add the block to (only for organization members)

Generated Request

Phản hồi mẫu

{
                    "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
                  }

Trường phản hồi

luid

Loại: chuỗi

Định danh duy nhất cho nội dung được tạo

slug

Loại: chuỗi

URL-friendly version of the content

words

Loại: số nguyên

Number of words in the content

remaining_daily_quota

Loại: số nguyên

Remaining content creation quota for today

Mã phản hồi

201Đã tạo (thành công)
400Yêu cầu sai (chuỗi không hợp lệ)
401Không được phép (token không hợp lệ)
403Forbidden (plan not sufficient)
422Invalid location coordinates

thêm vào khối

POSThttps://brainful.dev/blocks/append

Tham số yêu cầu

Tất cả tham số được gửi trong phần thân yêu cầu dưới dạng JSON.

Tham sốLoạiBắt buộcMô tả
identifierchuỗi Định danh của khối để nối thêm vào (luid hoặc slug)
chuỗichuỗiNội dung được nối thêm (1-5000 ký tự)

Generated Request

Phản hồi mẫu

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

Trường phản hồi

luid

Loại: chuỗi

Định danh duy nhất cho nội dung được tạo

slug

Loại: chuỗi

URL-friendly version of the content

words

Loại: số nguyên

Number of words in the content

remaining_daily_quota

Loại: số nguyên

Remaining content creation quota for today

Mã phản hồi

201Đã tạo (thành công)
400Yêu cầu sai (chuỗi không hợp lệ)
401Không được phép (token không hợp lệ)
403Forbidden (plan not sufficient)

lấy khối

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

Tham số yêu cầu

URL Parameters

Tham sốLoạiBắt buộcMô tả
luidchuỗiĐịnh danh duy nhất của khối cần truy xuất

Nội dung yêu cầu

Tham sốLoạiBắt buộcMô tả
latitudesố thập phânKhôngvĩ độ (-90° đến 90°)
longitudesố thập phânKhôngkinh độ (-180° đến 180°)
agentchuỗiKhông Định danh tác nhân (tối đa 50 ký tự)

Generated Request

Phản hồi mẫu

{
  "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 }

Trường phản hồi

creator

Loại: chuỗi

Username of the content creator

luid

Loại: chuỗi

Định danh duy nhất cho khối

type

Loại: chuỗi

Loại nội dung (ví dụ, "thought")

html

Loại: chuỗi

HTML nội dung của khối

created_timestamp

Loại: chuỗi

Creation date and time

hits

Loại: số nguyên

Number of views

Mã phản hồi

200Thành công (đã tìm thấy khối)
401Không được phép (token không hợp lệ)
403Forbidden (plan not sufficient)
404Không tìm thấy (không tìm thấy khối)

Cảm thấy được truyền cảm hứng?

Hãy xem một số tích hợp chính thức của chúng tôi được xây dựng bằng brainful User API ở đây!