美国国旗

美国政府的官方网站

Dot政府

官方网站使用.gov
A类.gov(政府)该网站属于美国政府的一个官方组织。

Https系统

Secure.gov网站使用HTTPS
A类()https(https)://表示您已安全连接到.gov网站。仅在官方安全网站上共享敏感信息。

这个页面有帮助吗?

Commerce.gov API公司

作为“美国数据机构”,商务部已做好准备,并处于有利地位,以推动开放数据革命的下一阶段。但我们不能单独做到这一点。我们需要你的帮助。我们邀请您使用我们的内容API来提高商务数据对政府、企业和公众的价值、可访问性和可用性。

下面是如何访问和使用我们的内容API的文档。对于与此API相关的任何问题、请求或改进意见,请立即作出回应提交问题到我们的Github储存库或者,您可以发送电子邮件[电子邮件保护]我们将在5个工作日内给您回复。

快速入门

API密钥

API密钥由API.data.gov提供。有关使用API密钥的完整文档,请访问https://api.data.gov/docs/api密钥/.

正在加载注册表单。。。

API基础知识

Commerce.gov内容通过GET API公开,网址为https://api.commerce.gov/api网站/

资源
终结点 它的作用
/api/博客 提供博客内容条目和字段
/api/新闻 提供新闻编辑室内容条目和字段
/api/图像 提供带字段的图像内容

数据结果存储在数据JSON响应的属性,而杰索纳皮,自己,下一个,第一、和上一个对象包含有关结果集的支持信息。

API详细信息

返回有关资源的文档

这可以通过带有cURL的HTTP请求或通过浏览器进行处理

  • cURL:使用HTTP选项请求时,您可以返回有关资源的机器结构化文档。为此,向资源的根URL发送OPTIONS请求。资源将使用包含资源中每个字段文档的JSON对象进行响应。示例如下:
  • 浏览器以下为:https://api.commerce.gov/api/blogs?api_key=DEMO_key

所有API的字段引用
字段名称 资源 描述 类型 基数
观众 全部的 已弃用.条目的目标受众 无效的 1
管理员(_O) 全部的 与入境相关的行政官员。对象数组或null。对象包含字段id、标签、href 阵列 无限制的
类别 全部的 与条目关联的类别。对象数组或为空。对象包含字段id,标签,href 阵列 无限制的
创建 全部的 以unix时间创建条目的日期(例如1511376420) 日期 1
文件 全部的 与条目关联的文档。对象数组或为空。对象包含字段id、标签、href 阵列 无限制的
画廊 全部的 已弃用.与条目关联的库 无效的 1
href公司 全部的 网站上单个条目(内容页面或全尺寸图像)的标准URI 一串 1
身份证件 全部的 已弃用与其中一个匹配的.ID国家识别码中间取决于API类型。条目的唯一标识符。 一串 1
组织 全部的 与条目关联的组织和组。对象数组或为空。对象包含字段id、标签、href 阵列 无限制的
标签 全部的 与条目关联的标记。对象数组或为空。对象包含字段id、标签、href 阵列 无限制的
类型 全部的 API方法名称(博客、图片、新闻) 一串 1
已更新 全部的 上次以unix时间更新条目的日期(例如1511376420) 日期 1
乌伊德 全部的 条目的唯一标识符,表示唯一通用标识符。 一串 1
博客API特定的字段-https://api.commerce.gov/api/blogs?api_key=DEMO_key
字段名称 资源 描述 类型 基数
身体 博客,新闻 条目的主要内容正文 一串 1
现场扬声器 博客,图像 与条目相关的演讲者。对象数组或为空。对象包含字段id、标签、href 阵列 无限制的
形象 博客,新闻 与条目关联的图像。对象数组或null。对象包含字段id、label、alt、height、filemime、width、copyright、title、created、href、filesize、styles和caption.有关详细信息,请参见图像特定字段. 阵列 无限制的
标签 博客、新闻 条目的标题文本(例如“示例条目”)。 一串 1
国家识别码 博客,新闻 条目的唯一标识符,表示节点ID。 整数 1
发布_日期 博客、新闻 以unix时间表示的条目的正式发布日期(例如1511376420) 日期 1
后_日期_格式 博客、新闻 YYYY-MM-DDThh:MM:ssP格式条目的正式发布日期。(例如2017-11-22T13:47:00-05:00) 日期 1
相关的 博客,新闻 与条目相关的其他内容。对象数组或为空。对象包含字段id、标签、href 阵列 无限制的
自己 博客、新闻 条目的自引用绝对URI 一串 1
戏弄者 博客,新闻 已弃用。关于条目的简短片段 一串 1
视频 博客,新闻 与条目关联的视频。对象数组或为空。对象包含字段id、标签、href 阵列 无限制的
特定于图像API的字段-https://api.commerce.gov/api/image?api_key=DEMO_key
字段名称 资源 描述 类型 基数
中高音 形象 图像的替换文本 一串 1
标题 形象 与图像关联的标题 一串 1
版权 形象 版权信息:USGW-美国政府工作;PDW-公共领域工作;CCL-Creative Commons许可证;LSI——许可库存图像;CW-版权作品;移民局-我不确定 一串 1
credit_line(信用线) 形象 标识图像的摄影师、插图画家或版权所有者 一串 1
字段扬声器 博客,图像 与条目相关的扬声器。对象数组或为空。对象包含字段id、标签、href 阵列 无限制的
文件模拟程序 形象 图像的Mime类型,例如“image/jpeg” 一串 1
文件大小 形象 图像的文件大小(字节) 整数 1
高度 形象 原始图像大小的高度(以像素为单位)。 整数 1
图像perm_creator 形象 来自图像创建者的权限:WPO-获得书面权限;移民局-我不确定 一串 1
图像perm个人 形象 照片中个人的许可:WPO-获得书面许可;VPO——获得口头许可;移民局-我不确定 一串 1
中间 形象 条目的唯一标识符,表示媒体ID。 整数 1
名称 形象 图像的标题文本(例如“示例文件”)。 一串 1
新闻_类型 图像、新闻 已弃用.按类型对新闻编辑室条目进行分类。例如,“新闻稿”、“报道”、“演讲”、“意见社论”和“概况介绍”。 无效的 1
样式 形象 图像的三种不同样式包括缩略图、中等和大。 对象 1
戏弄者 图像、新闻 已弃用.关于条目的简短片段 无效的 1
标题 形象 上传文件的名称(例如“SampleFile.jpg”)。 一串 1
宽度 形象 原始图像大小的宽度(以像素为单位)。 整数 1
特定于新闻API的字段-https://api.commerce.gov/api/news?api_key=DEMO_key
字段名称 资源 描述 类型 基数
身体 博客,新闻 条目的主要内容正文 一串 1
形象 博客,新闻 与条目关联的图像。对象数组或为空。对象包含字段id、label、alt、height、filemime、width、copyright、title、created、href、文件大小、样式和标题.有关详细信息,请参见图像特定字段. 形象 无限制的
标签 博客、新闻 条目的标题文本(例如“示例条目”)。 一串 1
新闻_类型 图像、新闻 按类型对新闻编辑室条目进行分类。例如,“新闻稿”、“报道”、“演讲”、“意见社论”和“概况介绍”。每个数组包含一个具有以下属性的对象:id、标签、href 阵列 1
国家识别码 博客、新闻 条目的唯一标识符,表示节点ID。 整数 1
发布_日期 博客、新闻 以unix时间表示的条目的正式发布日期(例如1511376420) 日期 1
后_日期_格式 博客、新闻 YYYY-MM-DDThh:MM:ssP格式条目的正式发布日期。(例如2017-11-22T13:47:00-05:00) 日期 1
出版 新闻 仅适用于意见编辑。外部网站上发布的原始文章的标题和URL。 一串 无限制的
相关的 博客,新闻 与条目相关的其他内容。对象数组或null。对象包含字段id、标签、href 阵列 无限制的
发布_状态 新闻 新闻稿、报告、演讲、意见评论/情况说明书等三种新闻编辑室类型的发布方式之一。立即放行,按交付准备。 一串 1
自己 博客,新闻 条目的自引用绝对URI 一串 1
演讲者 新闻 仅用于演讲。与条目关联的扬声器。对象数组或为空。对象包含字段id,标签,href 阵列 无限制的
字幕 新闻 编辑室条目的子标题。 一串 1
戏弄者 图像、新闻 已弃用。关于条目的简短片段。 无效的 1
视频 博客,新闻 与条目关联的视频。对象数组或为空。对象包含字段id、标签、href 阵列 无限制的

变更日志

  • 10/4/2019-新闻v2.1、博客v2.1、图片v2.1:重新编写了每个API,因为需要对底层JSON API模块进行更新。更新了几个字段以遵循JSON最佳实践,例如将字符串“null”更改为无效的。有关详细信息,请参阅此处。
  • 11/9/2018-新闻2.0版、博客2.0版、图片2.0版:完全重写API,以反映Commerce.gov D8网站的重新设计。API端点—新闻、博客和图像及其响应字段,以保持向后兼容性。高级功能(如返回特定字段、返回特定内容、应用查询筛选器、应用查询排序、API版本控制和更改请求格式化程序)不适用于此版本。具有null值的字段将作为具有null价值的字符串返回。示例“null”。
  • 9/23/2016-Image v1.0:Images/Photos的API资源端点的初始版本。将特定于图像的字段添加到字段引用和更新的资源列。
  • 12/5/2015-新闻v1.0:新闻室内容API资源端点的首次发布。将特定于新闻编辑室的字段添加到字段引用和新列中,以显示哪些字段可用于哪些内容类型。
  • 2015年7月10日-更新了其他查询筛选器运算符的文档。
  • 10/05/2015-更新了文档,以反映查询筛选器运算符的限制和标签字段上简单筛选器的工作示例。
  • 09/29/2015-博客v1.0:初始版本仅包含博客内容的API资源端点。
局和办公室
标签