此页面是否有帮助?

commerce.gov API

“美国的数据代理,”澳门皇冠体育准备并积极促进下一阶段的开放数据革命。但我们不能独自做到这一点。我们需要你的帮助。我们邀请您使用我们的内容API来提升价值,可访问性和商业数据的可用性,为政府,企业和公众。

下面你会发现如何访问和使用我们的内容API的文档。对于任何问题,要求或想法的改善与此相关的API,迅速回应,请 提交问题 我们 GitHub的库。另外,您也可以通过电子邮件 api@doc.gov 我们会在5个工作日内回复您。

上手

API密钥

API密钥是由api.数据.gov提供。有关使用API​​密钥访问完整的文档 https://开头api.数据.gov/docs/api-key/.

装载注册表格...

API基础知识

commerce.gov内容是通过可用获取API在暴露 https://开头api.commerce.gov/api/

资源
端点 它能做什么
/ API /博客 提供博客内容的项目和领域
/ API /新闻 编辑部提供内容的项目和领域
/ API /图像 提供图像内容的字段

数据结果被存储在 数据 JSON响应的性质,而 jsonapi, , 下一个, 第一上一页 对象包含有关结果集的支持信息。

API细节

返回文档中关于资源

这可以通过一个http请求,卷曲或经由浏览器进行处理

  • 卷曲:使用http 选项 请求时,你可以返回有关资源机器结构化文档。这样做,发送一个选项请求资源的根URL。资源将使用包含文件在资源领域的每一个JSON对象作出回应。下面的例子:
  • 浏览器: https://开头api.commerce.gov/ API /博客?api_key=demo_key
对所有API字段引用
字段名 资源 描述 类型 基数
听众 所有 弃用。观众在进入目标 空值 1
admin_officials 所有 行政官员与条目关联。任一对象或空的阵列。对象包含的字段 ID,标签,HREF 排列 无限
类别 所有 与条目相关的类别。任一对象或空的阵列。对象包含的字段 ID,标签,HREF 排列 无限
创建 所有 日期条目是在UNIX时间(例如1511376420)中创建 日期 1
文件 所有 与条目相关的文件。任一对象或空的阵列。对象包含的字段 ID,标签,HREF 排列 无限
画廊 所有 弃用。与条目相关画廊 空值 1
HREF 所有 标准URI对网站单次入境(内容页面或原图) 1
ID 所有 弃用。 ID匹配要么 NID 要么 根据API类型。唯一标识符的条目。 1
机构单位 所有 与条目相关组织和团体。任一对象或空的阵列。对象包含的字段 ID,标签,HREF 排列 无限
标签 所有 与条目关联的标签。任一对象或空的阵列。对象包含的字段 ID,标签,HREF 排列 无限
类型 所有 API方法名称(博客,图像,新闻) 1
更新 所有 日期的一项是在UNIX时间最后更新(例如1511376420) 日期 1
UUID 所有 对于入门唯一标识,代表着独特的通用标识。 1
具体到博客API领域 -  https://开头api.commerce.gov/ API /博客?api_key=demo_key
字段名 资源 描述 类型 基数
身体 博客,新闻 主要内容主体为入门 1
field_扬声器 博客,图像 扬声器相关条目。任一对象或空的阵列。对象包含的字段 ID,标签,HREF 排列 无限
图片 博客,新闻 (多个)图像与所述条目相关联。任一对象或空的阵列。对象包含的字段 ID,标签,ALT,高度,filemime,宽度,版权,标题,创建,HREF,文件大小,样式,和标题. 看到图像的特定字段的更多信息. 排列 无限
标签 博客,新闻 为条目标题文本(例如“样本条目”)。 1
NID 博客,新闻 对于入门唯一标识符,代表节点ID。 整数 1
发布日期 博客,新闻 官方发布日期为UNIX时间的条目(例如1511376420) 日期 1
发布日期_f要么matted 博客,新闻 官方发布日期为YYYY-MM-DDTHH条目:MM:SSP格式。 (例如2017-11-22t13:47:00-05:00) 日期 1
有关 博客,新闻 相关条目等内容。任一对象或空的阵列。对象包含的字段 ID,标签,HREF 排列 无限
博客,新闻 自引用的绝对URI的条目 1
传情 博客,新闻 弃用。有关条目的简短片段 1
视频 博客,新闻 与条目相关视频(S)。任一对象或空的阵列。对象包含的字段 ID,标签,HREF 排列 无限
具体到图像API的领域 -  https://开头api.commerce.gov/ API /图像?api_key=demo_key
字段名 资源 描述 类型 基数
ALT 图片 用于图像替代文本 1
字幕 图片 字幕与图像相关联 1
版权 图片 版权信息:usgw - 美国政府工作; PDW - 公共领域的工作; CCL - Creative Commons许可; LSI - 行货股票图像; CW - 版权作品;插件 - 我不知道 1
credit_line 图片 识别摄影师,插画或版权持有者的图象 1
field_扬声器 博客,图像 扬声器相关条目。任一对象或空的阵列。对象包含的字段 ID,标签,HREF 排列 无限
filemime 图片 图像的mime类型,如“图像/ JPEG” 1
文件大小 图片 以字节为单位的图像的文件大小 整数 1
高度 图片 原始图像大小有多高以像素为单位。 整数 1
图片_perm_creat要么 图片 从图像创建权限:WPO - 获得书面许可;插件 - 我不知道 1
图片_perm_indivIDual 图片 从照片的个人权限:WPO - 获得书面许可; VPO - 口头许可获得;插件 - 我不知道 1
图片 对于入门唯一标识符,代表介质ID。 整数 1
名称 图片 对于图像标题文本(例如,“示例文件”)。 1
新闻_类型 图像,新闻 弃用。按类型编辑部条目分类。例如。 “新闻稿”,“报道”,“演讲”,“专栏文章(论坛版)”和“情况说明”。 空值 1
款式 图片 该图像进来,包括缩略图,中,大三种不同的风格。 宾语 1
传情 图像,新闻 弃用。有关条目的简短片段 空值 1
标题 图片 已上载的文件的名称(例如“samplefile.jpg”)。 1
宽度 图片 原始图像大小有多宽以像素为单位。 整数 1
新闻特有的API领域 -  https://开头api.commerce.gov/ API /新闻?api_key=demo_key
字段名 资源 描述 类型 基数
身体 博客,新闻 主要内容主体为入门 1
图片 博客,新闻 (多个)图像与所述条目相关联。任一对象或空的阵列。对象包含的字段 ID,标签,ALT,高度,filemime,宽度,版权,标题,创建,HREF,文件大小,样式,和标题. 看到图像的特定字段的更多信息. 图片 无限
标签 博客,新闻 为条目标题文本(例如“样本条目”)。 1
新闻_类型 图像,新闻 按类型编辑部条目分类。例如。 “新闻稿”,“报道”,“演讲”,“专栏文章(论坛版)”和“情况说明”。每个阵列包含具有以下属性的1个对象: ID,标签,HREF 排列 1
NID 博客,新闻 对于入门唯一标识符,代表节点ID。 整数 1
发布日期 博客,新闻 官方发布日期为UNIX时间的条目(例如1511376420) 日期 1
发布日期_f要么matted 博客,新闻 官方发布日期为YYYY-MM-DDTHH条目:MM:SSP格式。 (例如2017-11-22t13:47:00-05:00) 日期 1
出版物 新闻 针对意见只社论。标题和URL的外部网站上发布的原创文章。 无限
有关 博客,新闻 相关条目等内容。任一对象或空的阵列。对象包含的字段 ID,标签,HREF 排列 无限
release_status 新闻 观点社论/其实片新闻发布会,报告,讲话,公布 - 三个选项指示如何编辑部类型之一。立即释放,作为准备交货,如交付。 1
博客,新闻 自引用的绝对URI的条目 1
扬声器 新闻 为演讲而已。与所述条目相关联的(多个)扬声器。任一对象或空的阵列。对象包含的字段 ID,标签,HREF 排列 无限
字幕 新闻 子标题编辑部项。 1
传情 图像,新闻 弃用。有关条目的简短片段。 空值 1
视频 博客,新闻 与条目相关视频(S)。任一对象或空的阵列。对象包含的字段 ID,标签,HREF 排列 无限

更新日志

  • 2019年10月4日 - 新闻V2.1,V2.1博客,图像V2.1:返工每个API作为更新被要求底层JSON API模块。几个领域进行了更新,以遵循JSON的最佳做法,如改变字符串“空值”来 空值。完整的详细信息可以在这里找到。
  • 2018年11月9日 - 新闻2.0版,2.0版的博客,图像V2.0:API的完全重写,以反映commerce.gov D8网站的重新设计。 API端点 - 新闻,博客和形象,他们的反应领域保持向后兼容性。先进的功能,例如返回特定字段,返回的具体内容,应用查询过滤器,将查询排序,API版本和变更请求格式是不适用于此版本。空值字段都返回字符串空值。例如“空”。
  • 2016年9月23日 - 图像V1.0:对图像/照片API资源端点的初始版本。添加的图像特定字段的字段引用和更新的资源列。
  • 2015年12月5日 - 新闻V1.0:为编辑部内容API资源端点的初始版本。到参考场和新的列添加编辑部特定字段要显示的字段可用于哪些内容类型。
  • 2015年10月7日 - 文档更新的额外查询过滤器运算符。
  • 2015年10月5日 - 文档更新,以反映查询过滤器运算符的限制和对标签字段简单的过滤器工作的例子。
  • 2015年9月29日  - 博客V1.0:初始版本仅包括用于博客内容的API资源端点。
分社和办事处
标签