快速上手 本文将介绍如何快速上手 Teable API 以及使用 API SDK
获取访问令牌
个人访问令牌是一种用于身份验证和授权的令牌。用于在为自己、客户或公司开发集成和扩展时对Teable的API进行身份验证。
第一步:创建一个访问令牌
进入令牌管理页面 ,点击”创建令牌“按钮来创建一个新的个人访问令牌。
为您的令牌添加可访问的数据库或者空间。令牌将只能在分配给它的数据库和空间中读取和写入数据。
一旦您的令牌创建成功,我们只会向您显示一次,我们建议您将其复制粘贴到你认为安全的地方进行存储。
你可以选择以下任一方式向 API 服务器发送请求, 首先选择一个你想要操作的表格,并获得表格 ID (如何获取?)
注意:在执行下列代码前,你需要将 __tableId__
和 __token__
替换为真实的表格 ID 和 API Token。
获取记录
以调用 "获取记录" API 接口为例,下面是一些常见语言的 HTTPS 请求示例:
CURL JS SDK TypeScript Python
复制 curl "https://app.teable.cn/api/table/__tableId__/record" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer __token___"
复制 import { configApi , getRecords } from '@teable/openapi' ;
const token = '__token__' ;
const tableId = '__tableId__' ;
configApi ({
endpoint : 'https://app.teable.cn' ,
token ,
});
getRecords (tableId)
.then (res => console .log ( res .data))
.catch (error => console .error ( 'Failed to fetch records:' , error));
// or use await in async function
// const res = await getRecords(__tableId__);
Fetch
复制 async function getRecords (token : string , tableId : string ) : Promise <{
records : {
id : string ;
fields : Record < string , unknown >;
name ?: string ;
autoNumber ?: number ;
createdTime ?: string ;
lastModifiedTime ?: string ;
createdBy ?: string ;
lastModifiedBy ?: string ;
}[];
}> {
const url = `https://app.teable.cn/api/table/ ${ tableId } /record` ;
const response = await fetch (url , {
method : 'GET' ,
headers : {
'Authorization' : `Bearer ${ token } ` ,
'Content-Type' : 'application/json'
}
});
return await response .json ();
}
const token = '__token__' ;
const tableId = '__tableId__' ;
getRecords (token , tableId)
.then (data => console .log (data))
.catch (error => console .error ( 'Failed to fetch records:' , error));
Axios
复制 import axios from 'axios' ;
async function getRecords (token : string , tableId : string ) {
const response = await axios .get ( `https://app.teable.cn/api/table/ ${ tableId } /record` , {
headers : {
'Authorization' : `Bearer ${ token } ` ,
'Content-Type' : 'application/json'
}
});
return response .data;
}
const token = '__token__' ;
const tableId = '__tableId__' ;
getRecords (token , tableId)
.then (data => console .log (data))
.catch (error => console .error ( 'Failed to fetch records:' , error));
复制 import requests
def get_records ( token : str , table_id : str ):
url = f 'https://app.teable.cn/api/table/ {table_id} /record'
headers = {
'Authorization' : f 'Bearer {token} ' ,
'Content-Type' : 'application/json'
}
response = requests . get (url, headers = headers)
response . raise_for_status ()
return response . json ()
token = '__token__'
table_id = '__tableId__'
try :
records = get_records (token, table_id)
print (records)
except Exception as e :
print (f 'Failed to fetch records: {e} ' )
获取记录时支持指定 视图,筛选条件,排序条件,fieldKeyType (以 Id 还是 Name 作为字段 key 进行返回), cellFormat(返回 JSON 还是纯文本格式的单元格数据)。我们为开发者提供了一个快捷的查询参数构建器 ,可以帮助轻松构建自定义的请求。
更多 API
记录增删改查 API 作为最常用的 API 我们准备了完善的说明文档
创建记录 更新记录 删除记录 其他的 API 可以在 Swagger文档 (可以在线调试)或者 Redoc文档 (说明信息更丰富)中查看,这里包括了 Teable 所有可用的 API。