SuperAPI AI 工具集

contentful-api

编程与开发

查看项目

更新于 10-15 20:27

技能介绍

用途:这是一份与编程语言无关的 Contentful REST API 指南,全部示例使用 HTTP/curl,帮助开发者按需调用 Contentful 的各套接口完成内容管理、读取、预览、图片变换与 GraphQL 查询。

主要能力分层:

  1. 共享参考:认证(令牌类型、认证请求头、美国/欧盟 API 基础地址)、HTTP 约定(版本锁定、速率限制、分页、错误、locale 结构)。
  2. 内容管理 API(CMA):用于管理内容、内容类型、资产与环境,属于读写接口。入口为 references/content-management/overview.md。其中 entries.md 覆盖条目的增删改查、发布/取消发布、版本控制与查询参数;content-types.md 定义与更新内容模型、字段类型和校验;assets.md 上传、处理并发布媒体文件;environments.md 创建、克隆、管理环境与别名。
  3. 内容交付 API(CDA):只读,用于获取已发布内容。入口为 references/content-delivery/overview.md。querying.md 讲过滤器、搜索操作符、分页与排序;includes-links.md 讲 include 参数与链接解析;localization.md 讲 locale 参数与回退链;sync.md 讲增量内容同步。
  4. 内容预览 API:通过相同的 CDA 端点访问草稿与已发布内容,仅主机与令牌不同,参考 references/content-preview/overview.md。
  5. 图片 API:通过 URL 参数进行实时图片变换,无需认证,参考 references/images/overview.md。
  6. GraphQL API:使用 CDA 令牌以 GraphQL 查询内容,参考 references/graphql/overview.md。

必要用法示例(保持原样):

CMA: Create a draft entry

curl -X POST https://api.contentful.com/spaces/{space_id}/environments/{env_id}/entries
-H "Authorization: Bearer {cma_token}"
-H "Content-Type: application/vnd.contentful.management.v1+json"
-H "X-Contentful-Content-Type: blogPost"
-d '{"fields":{"title":{"en-US":"Hello"}}}'

Then publish: PUT .../entries/{id}/published with X-Contentful-Version header

CDA: Fetch entries

curl "https://cdn.contentful.com/spaces/{space_id}/environments/{env_id}/entries?content_type=blogPost"
-H "Authorization: Bearer {cda_token}"

适用场景:需要以任意语言或脚本直接调用 Contentful 接口的开发者,可用于构建内容读写流程、定义内容模型、上传资产、管理环境、同步已发布内容、做图片变换或改用 GraphQL 查询。

限制:资料未提供具体收费、价格与配额信息;速率限制与错误处理仅作为章节提及,具体阈值与细节暂未提供;各令牌的具体获取方式也未在资料中说明。