请求

方法访问Sell APIhttps://api.getbase.com域。中发送和接收所有数据JSON格式和所有API请求都需要认证。

URL

             
              https：//api．getbase．com/｛api-版本｝/｛资源｝

地点:

https://-提供API只有超安全HTTP
api.getbase.com- API的端点域。
api版本- API版本标识符。v2．
资源- service-slug的API端点。联系人．

对API的所有请求必须通过SSL (https://不http://）.

HTTP动词

动词	描述
头	查询HTTP报头
得到	检索资源亚博电脑端
帖子	创建资源或执行自亚博电脑端定义操作
把	部分资源更新亚博电脑端
删除	删除资源亚博电脑端

查询参数

扩大

在许多情况下，您需要加载与所请求的资源相关的数据。我们不需要您重复地访问API，而是允许根据需要返回相关数据并与原始资源一起加载，这提高了性能。

使用我们的标准可以包含一亚博电脑端个或多个资源包括参数。的?包括参数将接受与主资源相关的一个或多个资源的逗号分隔列表，并返回这些资源。亚博电脑端

参考端点的参数描述，以验证支持哪些相关资源。亚博电脑端

例如，要检索id为“2”的联系人以及有关该联系人的关联组织的信息，请使用:

             
              旋度-X GET https://api.getbase.com/v2/contacts/2?includes＝组织＼- u＂YOUR_API_KEY美元："- h“接受:application / json”

过滤

Sell中的记录关系可能很复杂。url深度为5或6层的情况并不少见。通常，一旦我们有了感兴趣的级别的主键，我们就不需要包括上面的级别。

我们通过将可选状态和属性放在HTTP问号后面，使您尽可能简单地使用API。有关更多信息，请参阅下面的示例。

参考端点的参数描述，以检查该端点的哪些属性是可过滤的。

检索同一组织内的联系人，id为“1”，并且居住在同一城市- NY

             
              旋度-X GET https://api.getbase.com/v2/contacts?contact_id＝1＆城市＝“纽约”＼- u＂YOUR_API_KEY美元："＼- h“接受:application / json”

IDs过滤器

通过附加标准，可以控制在请求期间返回哪些单独的资源亚博电脑端id查询参数到集合URL。的ids吗?参数接受逗号分隔的唯一标识符列表。

检索id为“1”、“2”和“3”的联系人

             
              旋度-X GET https://api.getbase.com/v2/contacts?ids＝1、2，3＼- u＂YOUR_API_KEY美元："＼- h“接受:application / json”

自定义字段过滤器

除了标准属性，我们还支持自定义字段过滤。为了使用它，您需要将自定义字段设置为as滤过性的在自定义字段设置中。请记住，只支持以下自定义字段类型:“单行文本”，“数字”，“下拉”或“多选择”。

检索联系人的可筛选自定义字段sku设置为“SKU1”，使用:

             
              旋度-X GET https://api.getbase.com/v2/contacts?custom_fields［sku］＝SKU1＼- u＂YOUR_API_KEY美元："＼- h“接受:application / json”

分页

您可以使用标准控制返回的最大记录数per_page查询参数。要选择页面，请使用标准页面查询参数。

默认页面总是第一个。页码为基于并且省略页面吗?参数将返回第一页。

默认限制为25个，可返回的最大数量为100个。

             
              旋度-X GET https://api.getbase.com/v2/contacts?page＝2＆per_page＝One hundred.＼- u＂YOUR_API_KEY美元："＼- h“接受:application / json”

排序

您可以根据一个条件控制如何使用标准查询参数对资源集合进行排序sort_by．

的sort_by ?查询参数接受要排序的字段名。

默认的排序顺序是升序的。如果要将排序顺序更改为升序，请添加: asc字段(或将: desc显式指定降序)。

参考端点的参数描述，以检查哪些属性是可排序的。

例如，获取同一组织内的联系人列表并对其进行排序first_name按降序排列，使用:

             
              旋度-X GET https://api.getbase.com/v2/contacts?organization_id＝1＆sort_by＝first_name: desc＼- u＂YOUR_API_KEY美元："＼- h“接受:application / json”

自定义字段排序选项

除了标准属性，我们还支持自定义字段筛选。为了使用它，您需要将自定义字段设置为as滤过性的在自定义字段设置中。请记住，只支持以下自定义字段类型:“单行文本”，“数字”或“下拉”。

下面的查询显示如何根据自定义字段进行排序sku：? sort_by = custom_fields: sku: desc．

更详细地分析查询，sort_by操作符指示使用排序custom_fields: skuPart告诉我们按自定义字段排序sku，和剩余的元素desc指定要按降序排序。

按可筛选的自定义字段对联系人进行排序sku按降序排列，使用:

             
              旋度-X GET https://api.getbase.com/v2/contacts?sort_by＝custom_fields: sku: desc＼- u＂YOUR_API_KEY美元："＼- h“接受:application / json”

头

内容协商

当您想要JSON格式的响应时，需要指定此参数。这是通过接受头文件，并设置头文件的值为application / json．

             
              接受：应用程序/json

当您使用JSON格式时，您应该在头中指定您正在发送JSON请求。这可以通过设置内容类型头来application / json．这确保您的请求被我们的服务器正确地解释。

             
              内容-类型：应用程序/json

谈判语言

HTTP具有通过标准进行语言协商的内置支持接收语言头。接收语言与内容协商的工作方式相同:通过使用接受模式。标头使用语言标记，其中任何两个字母的主标记都是ISO-639语言缩写，任何两个字母的起始子标记都是ISO-3166国家代码。

如果您的请求没有Accept-Language，那么Sell API将以默认语言(可以通过仪表板更改)返回一个包含所有人类可读文本的表示。

             
              接受-语言：达，在-gb；1＝0.8，在；问＝0.7

用户代理

所有API请求必须包含有效的用户代理头。没有的请求用户代理标头将被拒绝400错误请求还有错误代码invalid_user_agent将包含在响应有效负载中。

             
              用户-代理：列出/1．0

身体

对象中承载的有效负载的对象类型数据字段。类型中包含对象的类型元/类型属性。的类型字段是必填项，除非给定端点的文档另有说明。

使用一个信封在请求中包含其他字段，如元数据、分页信息等。使用信封的另一个原因是，一些客户端不允许轻松访问HTTP标头，而JSONP请求根本无法访问HTTP标头。

             
              ｛“数据”：｛“内容”：“你的笔记内容”，“resource_id”：1，“resource_type”：“注意”｝，“元”：｛“类型”：“注意”/ /强制｝｝

日期和时间

日期和时间格式会导致很多混乱和互操作性问题。为了克服这个问题，我们采用了行业采用的标准，ISO 8601．即使我们在内部使用UTC时区存储所有时间戳，我们也不会对您提供的时区做任何假设。

部分3.7双方约定ISO 8601标准规定，我们可以自由地定义我们自己的表示，只要我们不干扰标准中定义的表示。有时，您可能希望指定一个过期时间并将其设置为永远．多亏了我们能达成一致的宽松标准9999 - 12 - 31 - t00:00:00z来表示永远．

下面是我们的Date-Time语法，其中时区偏移设置为Z表示UTC时区:

             
              {一}-{月}{一}T{小时}:{一}:{二},{纳秒}{时区偏移}2014 - 12 - 08 - t12:35:00z

自定义字段

您可以将任意数量的自定义字段分配给任何单个引领，联系或交易．对象的键值对custom_fields对象字段。

自定义字段必须通过设置来定义，然后才能分配。

大多数自定义字段值都是字符串，但有以下例外:

地址类中定义的嵌套对象地址文档。
列表值必须与“设置”中的下拉选项完全匹配。任何其他值都将被忽略。
多选择值是数组。它们的元素必须与设置中的下拉选项完全匹配。任何其他值都将被忽略。

在设置中未定义的任何自定义字段将被无声地忽略，而不会出现错误响应。

             
              ｛“数据”：｛//其他字段被跳过以提高可读性“custom_fields”：｛“网站”：“http://en.wikipedia.org/wiki/Wrigley_Field”，“通信”：｛“line1”：“1060 W。艾迪生”，“城市”：“芝加哥”，“postal_code”：“60613”，“状态”：“他”，“国家”：“美国”｝，“联盟”：“大联盟”，“体育”：［“棒球”，“足球”，“足球”，“曲棍球”］｝，“created_at”：“2014 - 08 - 27 - t16:32:56z”，“updated_at”：“2014 - 08 - 27 - t17:32:56z”｝，“元”：｛“类型”：“协议”｝｝

             
              ｛“数据”：｛//其他字段被跳过以提高可读性“标签”：［“重要”，“零售商”］，“created_at”：“2014 - 08 - 27 - t16:32:56z”，“updated_at”：“2014 - 08 - 27 - t17:32:56z”｝，“元”：｛“类型”：“协议”｝｝

身份验证

同步API

搜索API

twitter API

REST API资亚博电脑端源

应用程序

请求

URL