入门

基础 URL

https://api.ilepbase.com/api/v1

所有请求均使用标准 HTTP。本站文档中的接口均为公开访问，无需认证。

健康检查

使用健康检查接口确认服务可用性：

curl https://api.ilepbase.com/api/v1/health

响应示例：

{
  "success": true,
  "data": {
    "status": "ok",
    "service": "ilepbase-api",
    "version": "v1"
  },
  "timestamp": "2026-04-23T12:00:00.000Z"
}

请求约定

分页

返回列表的接口使用 page 与 pageSize 查询参数：

curl "https://api.ilepbase.com/api/v1/genomes?page=1&pageSize=10"

排序

支持排序的列表接口可传入 sortBy 与 sortDirection：

curl "https://api.ilepbase.com/api/v1/genomes?sortBy=buscoCompletePct&sortDirection=desc"

筛选

许多列表接口支持分面筛选。例如，基因组记录可按科筛选：

curl "https://api.ilepbase.com/api/v1/genomes?family=Papilionidae"

全文搜索

带有 q 参数的接口可在已索引字段上进行全文检索：

curl "https://api.ilepbase.com/api/v1/hostplants?q=abrostola"

速率限制

公开接口可能实施速率限制。启用限流时，相关状态会通过 X-RateLimit-* 响应头返回。

以下公开服务对每个 IP 有额外限制：

BLAST — 异步任务轮询仅限提交请求的 IP
MMNet — 每个 IP 最多 3 个并发识别请求
NicheBarcoding — 任务提交与轮询按 IP 限流

SDK 与工具

本 API 为标准 REST 接口，可使用 curl、fetch、axios、Python requests、R httr 等任意 HTTP 客户端访问，无需专用 SDK。

入门

目录