反应
不管请求是成功还是失败，Sell API总是用JSON响应。
头
内容协商
每当您从Sell API请求数据并通过接受头，Sell API将响应内容类型报头设置为请求的格式。方法将拒绝对服务器不支持的格式的请求406不可接受状态码。
内容-类型：应用程序/json；字符集＝utf-8
谈判语言
对象中包含有效负载的语言内容语言头。标头使用语言标记，其中任何两个字母的主标记都是ISO-639语言缩写，任何两个字母的起始子标记都是ISO-3166国家代码。
不同：内容-语言内容-语言：在
如果您的要求没有接收语言， Sell API将返回一个响应，其中包含所有人类可读的默认语言文本(可以通过仪表板更改)。
中有数据的请求接收语言头，Sell API将媒体类型排序问参数，选择列表中服务器可以支持的第一种语言，并包含不同:接收语言响应头。
如果有任何语言接收语言list不受支持，Sell API将使用您的默认语言。
请求唯一Id
每个响应都包含X-Request-Id标识特定请求的头。它具有随机的通用唯一标识符(UUID)格式:与返回的UUID相同logref在错误信封里。
当您在请求中遇到问题时，请与我们的支持团队联系以排除故障并附加唯一标识符(UUID)，这将帮助我们诊断问题。
X-请求-Id：05b84162-28aa-45b5-a531-8bf1a69120dc
身体
不管请求是成功还是失败，Sell API总是用JSON响应。
日期和时间
日期和时间格式会导致很多混乱和互操作性问题。为了克服这个问题，我们采用了行业采用的标准，ISO 8601．即使我们在内部使用UTC时区存储所有时间戳，我们也不会对您提供的时区做任何假设。
一节3.7双方约定ISO 8601标准规定，我们可以自由地定义我们自己的Date-Time表示，只要我们不干扰标准中定义的表示。结果表明永远，使用表示9999 - 12 - 31 - t00:00:00z．
下面是我们的Date-Time语法，其中时区偏移设置为ZUTC时区:
｛一年｝-｛月｝-｛一天｝T｛小时｝：｛一分钟｝：｛第二个｝，｛纳秒｝｛时区-抵消｝2014-12-08病人：35：00Z
信封
每个API响应都包装在一个称为信封，其中保存了API调用的结果，以及与请求相关的元数据。
| 的名字 | 描述 | 类型 |
|---|---|---|
项目 |
负载所携带的对象的集合。 | 集合 |
数据 |
负载所携带的物体。 | 取决于端点 |
错误 |
错误对象的集合。 | 集合 |
错误 |
错误对象。 | 错误 |
元 |
负载的元数据信息，如分页，类型等。 | - |
元
元数据信息为总是返回在惟一的响应体内元字段。
在一个成功的回应中元对象总是保存类型属性和分页信息(如果响应包含集合数组)。的类型可能是以下值之一:
| 的名字 | 例子 | 描述 |
|---|---|---|
集合 |
- | 对象的数组。 |
错误 |
- | 错误对象。 |
resource_name |
联系 |
负载携带的任意资源类型。 |
在错误响应中，元数据对象保存与错误相关的信息，例如http_status而且logref属性。
分页
分页信息包含在元身体信封的属性。
遵循链接的值而不是试图构造自己的url是至关重要的。
｛“项目”：［.．.］，“元”：｛“类型”：“收集”，“数”：25，“链接”：｛“自我”：“https://api.getbase.com/v2/contacts?page=1&per_page=25”，“next_page”：“https://api.getbase.com/v2/contacts?page=2&per_page=25”｝｝｝
元属性
| 的名字 | 描述 |
|---|---|
类型 |
响应的类型。 |
数 |
结果中的项数。 |
Meta的链接属性
| 的名字 | 描述 |
|---|---|
自我 |
结果的URL。 |
first_page |
结果的第一页的URL。 |
prev_page |
结果的前一页的URL。 |
next_page |
结果的下一页的URL。 |
last_page |
结果的最后一页的URL。 |
的链接对象将只包括相关链接。所以在搜索结果的第一页，没有first_page或prev_page参数将包括在内。
例子
在页面的右侧，您可以找到针对单个资源、资源集合和错误的一些示例服务器响应。亚博电脑端
单一资源响应
｛“数据”：｛“id”：2，“creator_id”：5339024，“contact_id”：1，“created_at”：“2014 - 08 - 27 - t16:32:56z”，“updated_at”：“2014 - 08 - 27 - t16:32:56z”，“标题”：“首席执行官”，“名称”：“Mark Johnson”，“first_name”：“马克”，“last_name”：“约翰逊”，“描述”："我是通过汤姆认识他的"，“网站”：“https://www.designservice.com”，“电子邮件”：＂(电子邮件保护)＂，“电话”：“508-778-6516”，“移动”：“508-778-6516”，“传真”：“+ 44-208-1234567”，“推特”：“mjohnson”，“facebook”：“mjohnson”，“linkedin”：“mjohnson”，“skype”：“mjohnson”，“owner_id”：5339024，“is_organization”：假，“地址”：｛“城市”：“海恩尼斯”，“line1”：“史密斯街2726号”，“postal_code”：“02601”，“状态”：“马”，“国家”：“我们”｝，“shipping_address”：｛“城市”：“海恩尼斯”，“line1”：“史密斯街2726号”，“postal_code”：“02601”，“状态”：“马”，“国家”：“我们”｝，“billing_address”：｛“城市”：“海恩尼斯”，“line1”：“史密斯街2726号”，“postal_code”：“02601”，“状态”：“马”，“国家”：“我们”｝，“行业”：“设计服务”，“标签”：［“重要”］，“custom_fields”：｛“known_via”：“汤姆”｝，“customer_status”：“没有”，“prospect_status”：“没有”，“parent_organization_id”：零｝，“元”：｛“版本”：3.，“类型”：“接触”｝｝
资源收集响应亚博电脑端
｛“项目”：［｛“数据”：｛“id”：1，“creator_id”：5339024，“contact_id”：零，“created_at”：“2014 - 08 - 27 - t16:32:56z”，“updated_at”：“2014 - 08 - 27 - t16:32:56z”，“标题”：零，“名称”：“设计服务公司”，“first_name”：零，“last_name”：零，“描述”：零，“网站”：“https://www.designservice.com”，“电子邮件”：零，“电话”：零，“移动”：零，“传真”：“+ 44-208-1234567”，“推特”：零，“facebook”：零，“linkedin”：零，“skype”：零，“owner_id”：5339024，“is_organization”：真正的，“地址”：｛“城市”：“海恩尼斯”，“line1”：“史密斯街2726号”，“postal_code”：“02601”，“状态”：“马”，“国家”：“我们”｝，“shipping_address”：｛“城市”：零，“line1”：零，“postal_code”：零，“状态”：零，“国家”：零｝，“billing_address”：｛“城市”：零，“line1”：零，“postal_code”：零，“状态”：零，“国家”：零｝，“行业”：“设计服务”，“标签”：［“重要”］，“custom_fields”：｛“known_via”：“汤姆”｝，“customer_status”：“没有”，“prospect_status”：“没有”，“parent_organization_id”：零｝，“元”：｛“版本”：3.，“类型”：“接触”｝｝，｛“数据”：｛“id”：2，“creator_id”：5339024，“contact_id”：1，“created_at”：“2014 - 08 - 27 - t16:32:56z”，“updated_at”：“2014 - 08 - 27 - t16:32:56z”，“标题”：“首席执行官”，“名称”：“Mark Johnson”，“first_name”：“马克”，“last_name”：“约翰逊”，“描述”："我是通过汤姆认识他的"，“网站”：“https://www.designservice.com”，“电子邮件”：“马克(电子邮件保护)＂，“电话”：“508-778-6516”，“移动”：“508-778-6516”，“传真”：“+ 44-208-1234567”，“推特”：“mjohnson”，“facebook”：“mjohnson”，“linkedin”：“mjohnson”，“skype”：“mjohnson”，“owner_id”：5339024，“is_organization”：假，“地址”：｛“城市”：“海恩尼斯”，“line1”：“史密斯街2726号”，“postal_code”：“02601”，“状态”：“马”，“国家”：“我们”｝，“shipping_address”：｛“城市”：“海恩尼斯”，“line1”：“史密斯街2726号”，“postal_code”：“02601”，“状态”：“马”，“国家”：“我们”｝，“billing_address”：｛“城市”：“海恩尼斯”，“line1”：“史密斯街2726号”，“postal_code”：“02601”，“状态”：“马”，“国家”：“我们”｝，“行业”：“设计服务”，“标签”：［“重要”］，“custom_fields”：｛“known_via”：“汤姆”｝，“customer_status”：“没有”，“prospect_status”：“没有”，“parent_organization_id”：零｝，“元”：｛“版本”：3.，“类型”：“接触”｝｝］，“元”：｛“类型”：“收集”，“数”：2，“链接”：｛“自我”：“https://api.getbase.com/v2/contacts?page=1&per_page=25”｝｝｝
错误响应
｛“错误”：［｛“错误”：｛“资源”：“接触”，“字段”：“/数据/ last_name”，“代码”：“空白”，“消息”："属性不能为空"，“细节”：“属性‘/data/last_name’不能为空(既不是空也不是空)。”｝，“元”：｛“类型”：“错误”，“链接”：｛“more_info”：“https://developers.getbase.com/docs/rest/articles/errors”｝｝｝］，“元”：｛“类型”：“错误”，“http_status”：422不可处理实体，“logref”：“b4bce554-8df2-48b1-9f68-a88e741463f0”，“链接”：｛“more_info”：“https://developers.getbase.com/docs/rest/articles/errors”｝｝｝