交易源API提供了一个简单的接口来管理交易源。这个API允许你创建、删除和更新你的源代码。您可以检索单个源,也可以检索所有源的列表。

JSON格式

的名字 只读 类型 描述
id 真正的 数量 交易源的唯一标识符。
creator_id 真正的 数量 创建源的用户的唯一标识符。
的名字 字符串 源名称。如。口碑传播
resource_type 字符串 源附加到的资源的类型名称。可能的值:交易
created_at 真正的 字符串 以UTC (ISO 8601格式)表示的创建日期和时间。
updated_at 真正的 字符串 上一次更新的UTC (ISO 8601格式)日期和时间。

检索所有资源

             
得到/v2/deal_sources

根据提供的参数返回用户可用的所有交易源。

参数

的名字 要求 类型 描述
页面 可选 数量 查询 开始的页码。页编号从1开始,并省略页面参数将返回第一页。
per_page 可选 数量 查询 每页要返回的记录数。默认限制为25可以返回的最大数目是One hundred.
sort_by 可选 字符串 查询 一个可以排序的领域。的默认的顺序是提升.如果要将排序顺序改为降序,请添加: desc到田野去。sort_by =名字:desc.可能的值:id的名字updated_atcreated_at
id 可选 字符串 查询 请求中要返回的交易源id列表,以逗号分隔。
的名字 可选 字符串 查询 要搜索的源的名称。该参数在严格意义上使用。

允许

  • 代理

使用旋度

             
旋度-v -X GET https://api.getbase.com/v2/deal_sources- h“接受:application / json”- h“授权:持票人ACCESS_TOKEN美元

示例响应

             
HTTP /1.1200好吧内容类型application / json;charset = utf8内容语言“项目”“数据”“id”1“creator_id”1“名称”“我们的网站”“resource_type”“协议”“created_at”“2014 - 08 - 27 - t16:32:56z”“updated_at”“2014 - 08 - 27 - t16:32:56z”“元”“类型”“源”“数据”“id”2“creator_id”1“名称”“口口相传”“resource_type”“协议”“created_at”“2014 - 08 - 27 - t16:32:57z”“updated_at”“2014 - 08 - 27 - t16:32:57z”“元”“类型”“源”“数据”“id”3.“creator_id”1“名称”“推荐”“resource_type”“协议”“created_at”“2014 - 08 - 27 - t16:32:58z”“updated_at”“2014 - 08 - 27 - t16:32:58z”“元”“类型”“源”“数据”“id”4“creator_id”1“名称”“报纸广告”“resource_type”“协议”“created_at”“2014 - 08 - 27 - t16:32:59z”“updated_at”“2014 - 08 - 27 - t16:32:59z”“元”“类型”“源”“元”“类型”“收集”“数”4“链接”“自我”“http://api.getbase.com/v2/sources.json”

创建一个源

             
帖子/v2/deal_sources

创建一个新源。源的名字必须是唯一的。

参数

的名字 要求 类型 描述
的名字 要求 字符串 身体 必须是唯一的。
resource_type 可选 字符串 身体 如。交易

允许

  • 代理

使用旋度

             
旋度-v -X POST https://api.getbase.com/v2/deal_sources- h“接受:application / json”- h“application / json内容类型:- h“授权:持票人ACCESS_TOKEN美元- d”{"数据":{“名称”:“汤姆”},"元":{“类型”:“源”} '

示例响应

             
HTTP /1.1200好吧内容类型application / json;charset = utf8内容语言“数据”“id”5“creator_id”1“名称”“汤姆”“resource_type”“协议”“created_at”“2014 - 08 - 27 - t16:33:00z”“updated_at”“2014 - 08 - 27 - t16:33:00z”“元”“类型”“源”

检索单个源

             
得到/v2/deal_sources/id

通过提供的id返回用户可用的单个源。如果具有所提供的唯一标识符的源不存在,则返回错误。

参数

的名字 要求 类型 描述
id 真正的 数量 查询 源的唯一标识符。

允许

  • 代理

使用旋度

             
旋度-v -X GET https://api.getbase.com/v2/deal_sources/5- h“接受:application / json”- h“授权:持票人ACCESS_TOKEN美元

示例响应

             
HTTP /1.1200好吧内容类型application / json;charset = utf8内容语言“数据”“id”5“creator_id”1“名称”“汤姆”“resource_type”“协议”“created_at”“2014 - 08 - 27 - t16:33:00z”“updated_at”“2014 - 08 - 27 - t16:33:00z”“元”“类型”“源”

更新源代码

             
/v2/deal_sources/id

更新源信息。如果指定的源不存在,请求将返回一个错误。如果您想要更新源代码,您可以必须确保源名称是唯一的。

参数

的名字 要求 类型 描述
id 真正的 数量 查询 源ID。
的名字 字符串 身体 必须是唯一的。如。汤姆推荐
resource_type 字符串 身体 如。交易

允许

  • 代理

使用旋度

             
旋度-v -X PUT https://api.getbase.com/v2/deal_sources/5- h“接受:application / json”- h“application / json内容类型:- h“授权:持票人ACCESS_TOKEN美元- d”{"数据":{“姓名”:“汤姆推荐”} '

示例响应

             
HTTP /1.1200好吧内容类型application / json;charset = utf8内容语言“数据”“id”5“creator_id”1“名称”“汤姆推荐”“resource_type”“协议”“created_at”“2014 - 08 - 27 - t16:33:00z”“updated_at”“2014 - 08 - 27 - t16:33:01z”“元”“类型”“源”

删除源

             
删除/v2/deal_sources/id

删除已存在的源。如果指定的源不存在,请求将返回一个错误。该操作无法恢复。

参数

的名字 要求 类型 描述
id 真正的 数量 查询 源的唯一标识符。

允许

  • 代理

使用旋度

             
旋度-v -X DELETE https://api.getbase.com/v2/deal_sources/1- h“授权:持票人ACCESS_TOKEN美元

示例响应

             
HTTP /1.1204没有内容