华谱 REST API v1

版本化接口、细粒度 Bearer 令牌、分页、隐私过滤和幂等写入。

下载 OpenAPI 3.1 JSON
在“管理 → API”创建令牌。写请求必须携带 8—100 位 Idempotency-Key;重复请求返回 Idempotency-Replayed: true。

认证

Authorization: Bearer hp_prefix_secret

示例

curl -H "Authorization: Bearer $HUAPU_TOKEN" \
  "http://localhost:8080/api/v1/clans/1/persons?page=0&size=50"

curl -X POST -H "Authorization: Bearer $HUAPU_TOKEN" \
  -H "Idempotency-Key: import-person-0001" \
  -H "Content-Type: application/json" \
  -d '{"surname":"Zhang","givenName":"Mou","gender":"UNKNOWN","living":true}' \
  "http://localhost:8080/api/v1/clans/1/persons"

接口

方法 路径 权限
GET /api/v1/clans CLAN_READ
GET /api/v1/clans/{id}/persons PERSON_READ
POST /api/v1/clans/{id}/persons PERSON_WRITE
GET /api/v1/clans/{id}/relations RELATION_READ
GET /api/v1/clans/{id}/sources SOURCE_READ
GET /api/v1/clans/{id}/changes CHANGE_READ
GET /api/v1/clans/{id}/audit AUDIT_READ + ADMIN

错误统一使用 application/problem+json。令牌可限定单一族谱;账号权限、对象隐私规则和令牌范围会同时生效。