brainful API库
概述
The brainful API 实现您的应用程序与 brainful's 强大的 内容管理系统. 无论您是在构建自动化工具还是与您心爱的应用集成, 我们的 RESTFUL API 提供了与您内容交互的简单安全方式.
主要特性
基于令牌的认证和HTTPS加密
标准HTTP方法和JSON响应
内置地理位置功能
为可靠性能而优化
使用场景
个人自动化
- 从您心爱的应用自动保存笔记
- 创建基于位置的内容触发器
- 连接到 IFTTT/Zapier 工作流
集成解决方案
- 构建自定义集成和扩展
- 创建自动化内容工作流
- 开发 内容管理系统
要求
60 每用户每分钟请求数
开始使用
获取您的API令牌
访问您的 brainful 选项页面 生成您的API令牌.
选择您的集成方法
从我们的示例代码中选择 cURL, JavaScript, 或 Python 快速开始.
发出您的第一个请求
试用下面的交互式示例来测试您的集成.
认证
所有API请求都需要在Authorization头中包含您的API令牌。从以下地址获取您的令牌 brainful 选项页面. API支持令牌和承载令牌两种格式.
Authorization: Token YOUR_API_TOKENAuthorization: Bearer YOUR_API_TOKEN创建区块
请求参数
所有参数在请求主体中作为 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) |
示例响应
{
"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
响应代码
附加到区块
请求参数
所有参数在请求主体中作为 JSON.
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
| identifier | 字符串 | 是 | 描述您想要附加到的区块 (luid 或 slug) |
| 字符串 | 字符串 | 是 | 要附加的内容 (1-5000 字符) |
示例响应
{
"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
响应代码
获取区块
请求参数
URL Parameters
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
| luid | 字符串 | 是 | 要检索的块的唯一标识符 |
请求主体
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
| latitude | 浮点数 | 否 | 纬度 (-90° 到 90°) |
| longitude | 浮点数 | 否 | 经度 (-180° 到 180°) |
| agent | 字符串 | 否 | 魔法实体 (至尊版 50 字符) |
示例响应
{
"creator": "johnnyappleseed",
"luid": "abc123",
"slug": "My New Block",
"type": "thought",
"html": "My New Block
响应字段
creator类型: 字符串
Username of the content creator
luid类型: 字符串
块的唯一标识符
type类型: 字符串
内容类型 (例如, "thought")
html类型: 字符串
HTML 内容区块
created_timestamp类型: 字符串
Creation date and time
hits类型: 整数
Number of views