家;支持;开发人员参考

本文档介绍了饲料结构。寻找饲料解析器？我们有样品图书馆PHP.，Visual Basic和C＃,Java．

概述

该参考文献旨在涵盖物品饲料的结构和内容。假设XML和HTTP的工作知识。

使用HTTP获取API的所有请求。在HTTP 200响应代码上会满足有效请求，而HTTP 4XX或5XX代码将满足无效请求。

本指南提供了与内容提要的分布式部分对应的示例url。除了API根之外，它是强烈推荐使用提供的href属性来发现提要内容的url。

关键术语

饲料
以结构化方式共同提供Brafton内容的一组XML文档。“提要”不是对任何特定XML结构的引用，而是对整个系统的引用。
文章
内容作为一个连贯整体的最终目的地。由于Brafton提要是供各种不同的内容管理系统和博客软件使用的，所以这是一个抽象的概念。精确的定义和实现留给了所讨论的软件。
API域
通常是一个提要的服务域api.brafton.com.．由您的客户经理提供。在本文档中，这是由此引用的{API域}- 查询API时，您应该将其与提供的域替换。
API密匙
一个GUID唯一标识由您的帐户经理提供的提要。在本文档中，这是由此引用的{API密匙}- 查询API时，您应该将其替换为您提供的键。

［跳转到上］

API根

的API根是提要及其解析器的起点，并提供核心信息，如提要的键、状态和URL，在这些位置可以找到最近发布的内容集合(新闻项目集合）。

API根的URL是http://{API域}/{API密匙}/

元素 值类型 描述
api XML节点 根节点。
关键 GUID 饲料的识别API密匙．
的名字 字符串 提要的友好名称。
饲料 枚举

提要的当前状态。这将是下列值之一:

  • Live - 此Feed可以接收新内容。
  • 试验 - 此饲料已准备好进行测试。在试用房屋中饲养一个或多个例子新闻项目。
  • 禁用-此提要不接收新内容。
消息 XML节点 提供href属性。news元素本身没有内部文本。
消息 [HREF.］ URL. 指定最近发布内容的集合的URL。
categoryDefinitions XML节点 提供href属性。元素categoryDefinitions本身没有内部文本。
类别文件[HREF.］ URL. 指定要在下面提交的内容类别的URL。所提供的URL中的数据将以类别集合．

示例响应

<？xml version = " 1.0 " encoding = " utf - 8 " ?> < api xmlns: xsi = " http://www.w3.org/2001/XMLSchema-instance " xmlns: xsd = " http://www.w3.org/2001/XMLSchema " > <键> 01234567 - 89 - ab - cdef - 0123 - 456789 -六边形abcdef < /关键> <名称>例子公司< /名称> < feedState >生活< / feedState > <新闻href = " http://api.brafton.com/01234567 - 89 - ab - cdef - 0123 - 456789 - abcdef/news/ " / > < categoryDefinitionshref = " http://api.brafton.com/01234567 - 89 - ab - cdef - 0123 - 456789 - abcdef/categorydefinitions/ " / > < / api >

［跳转到上］

新闻项目集合

的新闻项目集合是过去30天内零或多个已发布新闻项目的列表。如果在30天内没有发布任何项目，则集合将不包含任何项目。

新闻项目集合提供了提要中当前所有新闻项目的概述。News Item的完整内容可以在newsListItem href属性中提供的URL中检索。

元素 值类型 描述
消息 XML节点 新闻项目集合的根节点。提供状态属性，API根的镜像饲料节点。
newsListItem XML节点 代表集合中的新闻项目。新闻项目集合中可能存在零或更多NewsListItem节点。每个都提供HREF属性。
newslistitem [HREF.］ URL. 指定可以找到新闻项的唯一URL，其中可以找到完整文本和元数据。
ID 整数 新闻项目的内部，唯一ID。这些数字是由Brafton定义的，在提要中可能不是连续的。
publishDate 约会时间 客户批准新闻项目的日期和时间。
lastModifiedDate 约会时间 布拉夫顿作家或编辑最后修改新闻的日期和时间。
标题 字符串 新闻标题。

示例响应

<？xml version = " 1.0 " encoding = " utf - 8 " ?> <新闻状态= "活" xmlns: xsi = " http://www.w3.org/2001/XMLSchema-instance " xmlns: xsd = " http://www.w3.org/2001/XMLSchema " > < newsListItem href = " http://api.brafton.com/01234567 - 89 - ab - cdef - 0123 - 456789 - abcdef/news/123456/”> < id > 123456 < / id > < publishDate > 2009 - 12 - 04 - t13:00:00 < / publishDate > < lastModifiedDate > 2009 - 12 - 06 t15:50:31 < / lastModifiedDate >Example Article

［跳转到上］

新闻

一个新闻包含文章的内容和元数据。根据饲料构建的库应检查是否存在可选元素。

必需的元素

元素 值类型 描述
newsItem XML节点 新闻项目的根节点。提供编码属性。
newsitem [编码］ 枚举 定义提要内容的编码。可能是下列值之一:

  • UTF-8 -默认提要编码。指示可在内容中使用完整的Unicode字符集。
  • ASCII -遗留选项。表示内容中只能使用ASCII字符集。
ID 整数 新闻项目的内部，唯一ID。这些数字是由Brafton定义的，在提要中可能不是连续的。
状态 字符串 新闻项目的发布状态。弃用．将永远是“活”。
publishDate 约会时间 客户批准新闻项目的日期和时间。反映了各自的在新闻项目集合中发布．
createdDate 约会时间 新闻项目创建的日期和时间（当它由Brafton Writer启动时）。
lastModifiedDate 约会时间 布拉夫顿作家或编辑最后修改新闻的日期和时间。反映了各自的lastModifiedDate在新闻项目集合中．
标题 字符串 新闻标题。
类别 XML节点 提供href属性。这个节点本身不包含任何内部文本。
请注意：即使新闻项目没有相关类别，也将存在此节点。
类别(HREF.］ URL. 指定与此新闻项目关联的类别列表的URL。所提供的URL中的数据将以类别集合
相片 XML节点 提供href属性。这个节点本身不包含任何内部文本。
照片(HREF.］ URL. 指定与此新闻项目关联的照片列表的URL。
请注意：即使新闻项目没有相关照片，也将存在此节点。
文本 字符串 新闻项目的主要内容。内部文本是格式化的HTML格式，可能包含HTML标记和实体。

可选元素

元素 值类型 描述
htmlTitle 字符串 用于文章的HTML title标签中的文本。
htmlmetadescription. 字符串 用于或包含文章的HTML元描述的文本。
提取 字符串 新闻项目的介绍文本。
划线 字符串 这篇文章的作者是谁。
源 字符串 文章的引用来源，如网站URL、报纸或其他出版物。
htmlMetaKeywords 字符串 在HTML元关键字标签中使用的逗号分隔的关键字列表。
标签 字符串 与文章相关的逗号分隔标记列表。

示例响应

<？xml version = " 1.0 " encoding = " utf - 8 " ?> < newsItem编码= " utf - 8 " xmlns: xsi = " http://www.w3.org/2001/XMLSchema-instance " xmlns: xsd = " http://www.w3.org/2001/XMLSchema " > < id > 123456 < / id > <国家>生活> < /状态< publishDate > 2009 - 12 - 04 - t13:00:00 < / publishDate > < createdDate > 2009 - 12 - 02 t09:41:05 < / createdDate > < lastModifiedDate > 2009 - 12 - 06 t15:50:31 < / lastModifiedDate > <标题>的例子文章 该文本可能作为文章的介绍性文本出现。< /提取> <类别href = " http://api.brafton.com/01234567 - 89 - ab - cdef - 0123 - 456789 - abcdef/news/123456/categories/ " / > <照片href = " http://api.brafton.com/01234567 - 89 - ab - cdef - 0123 - 456789 - abcdef/news/123456/photos/ " / > <标题>示例文章标题< / > < htmlMetaDescription >这个文本将会在页面的meta描述——这就是读者将从搜索引擎看到。< text format="html">
文章主体出现在text标签中。
这个标签的内容在发布时将适应您的博客或内容管理系统上定义的风格。< / p > < /文本> < / newsItem >

［跳转到上］

类别集合

的类别集合提供类别列表。此集合中的项将引用提要的一组共享类别。集合本身最多只能与一个News Item相关联。

元素 值类型 描述
XML节点 包含零个或多个子节点的类别集合的根节点。该节点的名称取决于当前URL:

  • 类别文件 - 如果通过API Root类的ProciationDefinitions Href访问
  • 类别 - 如果通过新闻项目的类别的HREF访问
类别 XML节点 定义单个类别。
ID 整数 一个类别的内部唯一ID。这些数字是由Brafton定义的，在提要中可能不是连续的。
的名字 字符串 类别的人类可读名称。

示例响应

<？xml version = " 1.0 " encoding = " utf - 8 " ?>   654321 示例category

［跳转到上］

照片集合

一个照片集合是与新闻项目关联的图像列表。每个项目在一个照片收集，a照片，表示带有其内容摘要的图像。每个Photo将包含一组描述照片物理属性的子节点。这个集合统称为a照片实例．

照片必须保存在本地。前提是url不是长期服务的，并且在30天后无法访问。

元素 值类型 描述
相片 XML节点 集合的根节点。包含零个或多个子节点。
照片 XML节点 表示集合中的照片。包含图像元数据的子节点。
ID 整数 照片的内部唯一ID。这些数字是由Brafton定义的，在提要中可能不是连续的。
标题 字符串 与图像关联的文本，旨在作为标题。请注意：此节点是可选的，并且可能在所有馈送中都不存在。
htmlAlt 字符串 与图片相关联的文本，作为图像的替换文本。请注意：此节点是可选的，并且可能在所有馈送中都不存在。
取向 枚举 定义照片的主轴或最长轴。可能是下列值之一:

  • 纵向-主轴是Y轴(较长的高度)。
  • 景观 - 主轴是X轴（较长宽度）。
实例 XML节点 照片实例的父节点。包含一个或多个子节点。
实例 XML节点 定义照片实例。包含具有附加图像元数据的子节点。
宽度 整数 照片实例的宽度，以像素为单位。
高度 整数 照片实例的高度，以像素为单位。
类型 枚举 照片实例的相对大小。可能是下列值之一:

  • 小 - 相对小的照片实例。适用于缩略图和低分辨率移动设备。
  • 媒体 - 照片的相对中等大小的实例。对于文章的全文显示。
  • 大 - 一个相对大的照片实例。有用的是以其显示为突出显示否则难以阅读的细节或文本。
  • 缩略图-照片的缩略图大小的实例。用于预览。

    弃用．被小取代。

  • Fullsize -照片的原始大小。用于显示细节或作为独立图像显示。

    弃用．大量取代。
URL. URL. 临时服务此照片实例的URL。

请注意：照片实例在30天后无效，必须在本地保存以确保长期存储。请勿链接到文章中的照片实例。

示例响应

<？xml version = " 1.0 " encoding = " utf - 8 " ?>   98765 与图片相关的文章标题。 提供alt标签的文本，便于访问。 Landscape   500 334 Large http://pictures.brafton.com/Example-article-image.jpg

［跳转到上］

价值类型

类型 描述 文字
约会时间 日期分量和时间分量的组成。 一个时间戳ISO 8601.格式。
GUID 一个G埃UnID格式为xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx。不区分大小写。 数字0-9和字母a-f。
字符串 一系列Unicode字符。除非另有说明，否则字符串是免费文本，而不是用于HTML或URL的消毒。 所有unicode字符。不支持转义序列。
URL. 识别Internet资源的一系列Unicode字符。 有效的URL，以http：//或https：//开头。
整数 32位无符号整数。 所有文字由数字0-9组成。
枚举 约束为一组值的字符串。有关有效值列表，请参阅特定元素的描述。 所有unicode字符。不支持转义序列。

［跳转到上］