CMS API参考
Webflow CMS API是一个HTTP JSON API,它允许你通过编程方式从Webflow CMS中添加、更新和删除项目,允许你将外部数据源连接到你的Webflow站点。
您可以通过HTTP直接访问API,通过官方JavaScript API客户端,或通过任何第三方集成为您选择的语言。
数据模型
Webflow中的内容是围绕三个资源构建的:网站,集合,项目.
网站映射到Webflow网站。您可以检索用户能够管理的网站的基本信息,但目前创建新网站或更新现有网站的元数据仅限于web界面,不能通过API访问。
集合是项目的分组。给定集合中的所有项共享同一组自定义字段,或模式。定义集合仅限于web界面,但是API允许您查询关于集合的基本细节并从这些集合中获取分页项。
项目表示集合中的各个内容片段。项有一组字段模式,由它们所属的集合决定。该API允许读取、创建、更新和删除内容项。
更新日志
2022年8月17日
增加了对发布和删除多个集合项的支持-我们加入了发布收集物品而且删除收藏物品命令。
Webflow SDK更新到0.8.1——我们的Webflow node . js SDK已更新为
0.8.1
其中包括支持多项发布和删除的方法。
2022年7月28日,
2022年6月23日
- Webflow SDK更新到0.8.0——我们的Webflow node . js SDK已更新为
0.8.0
其中包括方法和类型来支持我们的新用户API在β(目前)。
2022年6月21日
API版本默认为当前版本-我们不再需要
accept-version
或api_version
与每个API请求一起传递。如果没有提供,我们将使用当前的API版本。已经有使用版本的代码?没烦恼!这也很好。增加了redirect_uri到OAuth文档-我们一直在验证
redirect_uri
当使用时,但没有记录…直到现在!了解更多关于如何使用redirect_uri
在我们的OAuth节.
2022年6月16日
加入人- - -
memberships_user_account_added
而且memberships_user_account_updated
添加了Webhook触发器。开发人员网站更新-这个开发者网站已经更新了一点,改进了语法高亮显示和更多语言的例子。我们还将OAuth移到了主页上,最棒的是——它现在是由OpenAPI规范生成的。仍在不断改进WIP和格式。
2022年5月27日
项目取消发布API-我们在Webflow上推出了一个新功能取消发布个人物品我们已经创建了相应的api !您现在可以使用取消发布API在代码中管理内容状态。注意:如果您正在使用Webflow node . js SDK,则需要更新
0.7.2
.项目取消发布Webhook- - -
collection_item_unpublished
添加了Webhook,当unpublish被触发时,您可以收到通知。网站发布Webhook- - -
site_publish
webhook现在包括域
而且publishedBy
,这样你就不必再好奇是谁和什么东西出版了。更新产品文档已欧宝体育在线首页更正-有一条额外的路线
更新产品欧宝体育在线首页
早就偷偷溜进来的医生,但我们发现了,现在修好了。如果你看到其他的,请让我们知道!
2022年5月12日
- Webflow SDK更新到0.7.2——我们的Webflow node . js SDK已更新为
0.7.2
.此更新包括一个关键的更新删除接受查询字符串的调用。在上面了解有关该版本的更多信息GitHub.
2022年3月31日
- Webflow SDK更新到0.7.1——我们的Webflow node . js SDK已更新为
是0.7.1
.这是一个很大的更新,包括对所有依赖项的更新,固定的类型和一个item()的错误消息打印错误.在上面了解有关该版本的更多信息GitHub.
存档
2020年3月31日
将电子商务分为收款、订单和库存
增加了产品、sku和类别的集合模型欧宝体育在线首页
新增产品创建欧宝体育在线首页端点
2017年2月2日
增加了发布站点的端点
增加了查询站点自定义域的端点
2016年11月30日
- 最初版本
开始
HTTP动词
我们的API试图为每个端点使用最合适的HTTP谓词。我们使用了以下动词:
动词 | 描述 |
---|---|
得到 | 获取资源(年代) |
帖子 | 创建一个新资源 |
补丁 | 更新新资源 |
把 | 更新资源 |
删除 | 删除一个资源 |
参数
请求可以同时具有必填项和/或可选参数。
根据HTTP谓词的不同,参数可以在URL本身中,也可以在请求体中。
线路参数
路由参数将被定义为给定API端点的路径的一部分。它们将用单独的颜色突出显示,并以冒号(:
),方便浏览。
例如:
获得/网站/: site_id/集合
在这个例子中,site_id
是路由参数。
查询字符串
得到
请求的参数将通过查询字符串传入。
例如:
/信息吗?喷火=bar&abc=123
在本例中,查询字符串包含两个参数,喷火
而且美国广播公司
.
curl https://api.www.raktarban.com/ \ -H“application / json内容类型:\——data-binary美元“{"key": "value"}”
请求体
所有其他请求的参数都将作为json格式的请求体的一部分传入。帖子
,把
而且补丁
包括json格式的请求体在内的请求应该确保内容类型
头文件被设置为application / json
.
身份验证
为了访问API,您需要提供一个访问令牌,以便通过API服务器进行身份验证。所有API请求都需要那个令牌。您可以通过两种方式之一获得该令牌。
获得API令牌后,最好是通过HTTP标头或查询字符串参数提供它。
API密钥
除了授权代码授予
,它也有可能得到access_tokens
个人应用程序。
如果您正在开发Webflow的私有集成,并且您只与您自己的帐户交互,有一个简化的过程来获得一个access_token
而不必注册和OAuth应用程序并实现完整的授权代码授予
流。您只需生成一个API密钥(相当于access_token
)从Webflow仪表板。
API密钥可以在每个站点的基础上生成。
网站的API密钥
要为站点生成API密钥,请在仪表板中打开站点并导航到“设置”窗格。有一个名为“API访问”的部分,在这里您可以生成一个新的API密钥。
HTTP报头
令牌在头
curl https://api.www.raktarban.com/info \ -H“授权:无记名d59f681797fbb3758b2a0ce8e5f31a199e2733110cb468bb2bb0d77f23417b32”
常量Webflow=需要(“webflow-api”);常量webflow =新Webflow({令牌:“d59f681797fbb3758b2a0ce8e5f31a199e2733110cb468bb2bb0d77f23417b32”});webflow。信息()。然后((信息) = >控制台.日志(信息));
应该使用以下头文件:
授权:无记名<标记>
查询字符串
如果不能在标头中设置访问令牌,也可以将其作为带有参数的查询字符串的一部分传入access_token
.
查询字符串中的令牌
curl https://api.www.raktarban.com/info?access_token=d59f681797fbb3758b2a0ce8e5f31a199e2733110cb468bb2bb0d77f23417b32
速度限制
默认速率限制是每分钟60个请求。每个请求都有两个速率限制相关的头文件:
X-RateLimit-Remaining
- 包含当前分钟内剩余的可用请求数
X-RateLimit-Limit
- 包含当前每分钟的总体速率限制
速率限制错误示例
{“味精”:“速率限制”,“代码”:429,“名称”:“RateLimit”,“路径”:“/网站”,“呃”:"RateLimit:速率限制命中"}
超过速度限制
为了保护我们的服务质量,超过您的速率限制将导致HTTP 429错误,要求您减慢您的请求速率。
如果您看到了这些错误,您应该确保您的应用程序被构建为限制其执行的请求速率。例如,当等待创建资源时(而不是使用webhook),或者进行大量高并发的API调用时,它可以被积极轮询触发。
API版本
除了访问令牌之外,请求还必须指定它们应该使用的API版本。
版本在头
curl https://api.www.raktarban.com/info \ -H“Accept-Version: 1.0.0”
//包的版本默认为最新的API版本:常量webflow =新Webflow({令牌: api_token});//你也可以指定一个API版本作为'version'选项:常量webflow =新Webflow({令牌: api_token,版本:“1.0.0”});
HTTP报头
方法可以指定版本Accept-Version
头
变量的名称
查询字符串中的版本
curl https://api.www.raktarban.com/info?api_version=1.0.0
此外,版本可以在查询字符串中指定为api_version
Semver
Semver(语义版本控制)
错误
样本误差响应
{“味精”:“不能访问资源”,“代码”:401,“名称”:“未经授权的”,“路径”:“/网站/ invalid_site”,“呃”:"未经授权:无法访问资源"}
错误响应格式
参数 | 描述 |
---|---|
代码 |
HTTP错误代码 |
味精 |
错误消息 |
的名字 |
错误的名称 |
路径 |
导致错误的请求路径 |
犯错 |
完整的错误字符串 |
问题 | 错误数组(通常是onValidationErrors ) |
标准错误
以下是我们的API返回的标准API代码。
状态 | 的名字 | 描述 |
---|---|---|
400 | SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
400 | InvalidAPIVersion | 请求的API版本无效 |
400 | UnsupportedVersion | 请求的API版本被请求的路由不支持 |
400 | NotImplemented | 该特性目前尚未实现 |
400 | ValidationError | 验证失败(见问题 字段) |
400 | 冲突 | 请求与现有数据冲突。 |
401 | 未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 | NotFound | 请求的资源未找到 |
429 | RateLimit | 已达到所提供的access_token的速率限制。请尊重您的申请X-RateLimit-Remaining 我们在API响应中包含的头。 |
500 | ServerError | 我们的服务器出了问题。稍后再试。 |
400 | UnknownError | 发生了一个错误,这里没有列举,但不是服务器错误。 |
OAuth
我们使用OAuth2将第三方应用程序与Webflow集成。在与API交互之前,开发人员应该登记他们的应用程序其中将生成client_id和client_secret。
Webflow支持授权代码授予流。与Webflow集成的应用程序需要执行以下步骤:
OAuth应用程序
注册一个应用程序
应用程序可以注册到用户、团队或工作区。
用户
要将应用程序注册为用户,请打开帐户设置的集成选项卡,点击“注册新申请”按钮。
团队或工作空间
要将应用程序注册为团队或工作区,请在中的单击Team或工作区打开设置页面仪表板概述页面.然后导航到集成部分并单击“注册新应用程序”按钮。
注册时需要填写以下字段:
字段 | 描述 |
---|---|
应用程序名称 | 当某人授权您的应用程序时将出现的应用程序的名称。 |
应用程序描述 | 将出现在授权请求页面上的简短描述。 |
重定向URL | 在用户批准/拒绝授权请求后,我们将用户重定向到的URL。URL必须以https 并通过SSL服务。 |
应用程序的主页 | 一个到应用程序主页的链接。 |
注册后,您应该看到client_id
而且client_secret
应用程序的令牌。您将需要这些来为您的应用程序的用户创建授权。
用户授权
将用户导向指定正确参数的授权URL。当它们接受或拒绝授权请求时,用户将被重定向回redirect_url
提供在OAuth应用程序设置。
请求
得到//www.raktarban.com/oauth/authorize
参数 | 描述 |
---|---|
client_id |
应用程序的惟一ID。可在仪表板 |
response_type |
这个值应该总是应该是代码 |
redirect_uri |
要重定向回的URI(必须与OAuth App设置中使用的URI匹配) |
状态 |
应用程序为CSRF保护提供的令牌值 |
最终的URL应该像这样,但是用你自己的client_id和可选的状态参数替换:
//www.raktarban.com/oauth/authorize/?client_id=8151ef1a5613fe2340e62395008595d23b31e15edfd0c5b1a49ad3560d5ca16b&response_type=code
您将通过在应用程序设置期间指定的重定向URL接收对授权请求的响应,并且可以进行更新在仪表板中
响应
参数 | 描述 |
---|---|
代码 |
用于为用户检索access_token的授权代码。只能使用一次。 |
状态 |
如果提供,则与原始值相同。 |
错误响应
参数 | 描述 |
---|---|
状态 |
如果提供,则与原始值相同。 |
错误 |
一个错误代码,指定这错误occured |
error_description |
发生的错误的人类可读的描述。 |
请求访问令牌
Curl https://api.www.raktarban.com/oauth/access_token \ -d client_id=“8151 ef1a5613fe2340e62395008595d23b31e15edfd0c5b1a49ad3560d5ca16b”\ - d client_secret =“94 cd4c5ac02604185a4ce2bca3f46c14c60ed9c5df86f76b43089997d8febfcf”\ - d代码=“c64a5accd53542c485e97a90e287ac18f522ec828947696fb13feb5255e3c42f”\ - d grant_type =“authorization_code”
{“token_type”:“持票人”,“access_token”:“79 f75b59455167fdb72d3f777409d390a3a93c048539ec6ddc34327cb312627e”}
一旦代码
已从重定向URL检索,要完成授权,您的应用程序必须请求access_token
.
的access_token
授权后应尽快提出申请,因为未经确认的授权有效期仅为30分钟。
请求
文章https://api.www.raktarban.com/oauth/access_token
参数 | 描述 |
---|---|
client_id |
应用程序的惟一ID。可在仪表板 |
client_secret |
您的应用程序独有的私有值。可在仪表板 |
代码 |
用于为用户检索access_token的授权代码。只能使用一次。 |
grant_type |
总是应该authorization_code |
redirect_uri |
该URI必须与最初提交的URI匹配(如果发送了一个URI) |
响应
参数 | 描述 |
---|---|
token_type |
永远都是“承载者” |
access_token |
在代表用户发出API请求时使用的标记 |
错误响应
参数 | 描述 |
---|---|
错误 |
一个错误代码,指定这错误occured |
error_description |
发生的错误的人类可读的描述。 |
撤销授权
Curl https://api.www.raktarban.com/oauth/revoke_authorization \ -d client_id=“8151 ef1a5613fe2340e62395008595d23b31e15edfd0c5b1a49ad3560d5ca16b”\ - d client_secret =“94 cd4c5ac02604185a4ce2bca3f46c14c60ed9c5df86f76b43089997d8febfcf”\ - d access_token =“79 f75b59455167fdb72d3f777409d390a3a93c048539ec6ddc34327cb312627e”
请求
文章https://api.www.raktarban.com/oauth/revoke_authorization
参数 | 描述 |
---|---|
client_id |
应用程序的惟一ID。可在仪表板 |
client_secret |
您的应用程序独有的私有值。可在仪表板 |
access_token |
在前一个授权流上接收的令牌 |
撤销响应
{“didRevoke”:真正的}
响应
参数 | 描述 |
---|---|
didRevoke |
在成功撤销时为真 |
错误响应
参数 | 描述 |
---|---|
错误 |
一个错误代码,指定这错误occured |
error_description |
发生的错误的人类可读的描述。 |
OAuth错误
授权错误
返回到应用程序重定向URL设置的查询字符串中的错误
错误代码 | 描述 |
---|---|
invalid_request |
|
unsupported_response_type |
|
access_denied |
访问代码错误
类API返回的错误POST / oauth / access_token
端点
错误代码 | 描述 |
---|---|
unsupported_grant_type |
grant_type 应该总是指定为字符串:authorization_code |
invalid_client |
没有找到与所提供的凭据匹配的OAuth应用程序 |
invalid_grant |
提供代码 是无效的 |
元
当前授权用户
当前授权用户的基本信息。
请求
GET /用户
参数
壳牌的例子
curl -request GET \——url https://api.www.raktarban.com/user \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/user”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“/用户”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/user”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/user”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/user”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
响应
示例响应
{“用户”:{“_id”:“545 bbecb7bdd6769632504a7”,“电子邮件”:“some.com”,“firstName”:“一些”,“姓”:“一”}}
的名字 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 用户的唯一id |
电子邮件 |
字符串 | 用户的电子邮件地址 |
firstName |
字符串 | 用户的名字 |
姓 |
字符串 | 用户的姓 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
当前授权信息
关于当前使用的授权的基本信息。
请求
GET /信息
参数
壳牌的例子
curl -request GET \——url https://api.www.raktarban.com/info \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/info”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“/信息”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/info”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/info”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/info”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
响应
示例响应
{“_id”:“55818 d58616600637b9a5786”,“createdOn”:“2016 - 10 - 03 - t23:12:00.755z”,“grantType”:“authorization_code”,“lastUsed”:“2016 - 10 - 10 - t21:41:12.736z”,“网站”:[“62 f3b1f7eafac55d0c64ef91”],“组织”:[“551 ad253f0a9c0686f71ed08”],“工作区”:[],“用户”:[“545 bbecb7bdd6769632504a7”],“rateLimit”:60,“状态”:“确认”,“应用程序”:{“_id”:“55131 cd036c09f7d07883dfc”,“描述”:“OAuth测试应用程序”,“主页”:“//www.raktarban.com”,“名称”:“测试应用程序”,“所有者”:“545 bbecb7bdd6769632504a7”,“ownerType”:“人”}}
的名字 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 授权的唯一id |
createdOn |
字符串 | 创建授权的日期 |
grantType |
字符串 | 授权的授予类型 |
lastUsed |
字符串 | 授权最后使用的日期 |
网站 |
(字符串) | 授权的网站 |
组织 |
(字符串) | 组织授权 |
工作区 |
(字符串) | 工作区授权 |
用户 |
(字符串) | 用户授权 |
rateLimit |
整数 | 授权的默认速率限制 |
状态 |
字符串 | 授权的状态 |
应用程序 |
应用程序 | 的实例应用程序对象。 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
网站
网站列表
提供的访问令牌能够访问的所有站点的列表。
请求
GET /网站
参数
壳牌的例子
curl -request GET \——url https://api.www.raktarban.com/sites \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/sites”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“/网站”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
响应
示例响应
[{“_id”:“580 e63e98c9a982ac9b8b741”,“createdOn”:“2016 - 10 - 24 t19:41:29.156z”,“名称”:“api_docs_sample_json”,“短”:“api-docs-sample-json”,“lastPublished”:“2016 - 10 - 24 t23:06:51.251z”,“previewUrl”:“https://d1otoma47x30pg.cloudfront.net/580e63e98c9a982ac9b8b741/201610241603.png”,“时区”:“美国/ Los_Angeles”,“数据库”:“580 e63fc8c9a982ac9b8b744”},{“_id”:“580 ff8c3ba3e45ba9fe588bb”,“createdOn”:“2016 - 10 - 26 t00:28:54.191z”,“名称”:“api_docs_sample_json副本”,“短”:“api -文档示例json - 086 c6538f9b0583762”,“lastPublished”:零,“previewUrl”:“https://d1otoma47x30pg.cloudfront.net/580e63e98c9a982ac9b8b741/201610241603.png”,“时区”:“美国/ Los_Angeles”,“数据库”:“580 ff8c3ba3e45ba9fe588bf”},{“_id”:“580 ff8d7ba3e45ba9fe588e9”,“createdOn”:“2016 - 10 - 26 t00:29:13.634z”,“名称”:“api_docs_sample_json副本”,“短”:“api-docs-sample-json-ce077aa6c5cd3e0177”,“lastPublished”:零,“previewUrl”:“https://d1otoma47x30pg.cloudfront.net/580e63e98c9a982ac9b8b741/201610241603.png”,“时区”:“美国/ Los_Angeles”,“数据库”:“580 ff8d7ba3e45ba9fe588ed”}]
的名字 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 网站的唯一标识符 |
createdOn |
字符串 | 网站创建日期 |
的名字 |
字符串 | 场地名称 |
短 |
字符串 | 名字的钝化版本 |
lastPublished |
字符串 | 上次发布的日期 |
previewUrl |
字符串 | 为给定站点生成的图像的URL |
时区 |
字符串 | 在“站点设置”中设置站点时区 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
让网站
通过站点id获取站点
请求
获得/网站/: site_id
参数
壳牌的例子
curl -request GET \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741 \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“/网站/ 580 e63e98c9a982ac9b8b741”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
响应
示例响应
{“_id”:“580 e63e98c9a982ac9b8b741”,“createdOn”:“2016 - 10 - 24 t19:41:29.156z”,“名称”:“api_docs_sample_json”,“短”:“api-docs-sample-json”,“lastPublished”:“2016 - 10 - 24 t19:43:17.271z”,“previewUrl”:“https://d1otoma47x30pg.cloudfront.net/580e63e98c9a982ac9b8b741/201610241243.png”,“时区”:“美国/ Los_Angeles”,“数据库”:“580 e63fc8c9a982ac9b8b744”}
的名字 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 网站的唯一标识符 |
createdOn |
字符串 | 网站创建日期 |
的名字 |
字符串 | 场地名称 |
短 |
字符串 | 名字的钝化版本 |
lastPublished |
字符串 | 上次发布的日期 |
previewUrl |
字符串 | 为给定站点生成的图像的URL |
时区 |
字符串 | 在“站点设置”中设置站点时区 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
发布网站
发布网站
请求
POST /网站/: site_id/出版
参数
壳牌的例子
请求POST \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/publish \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”\——头“application / json内容类型:\——数据'{"domains": ["test-api-domain.com"]}'
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“职位”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/publish”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”,“内容类型”:“application / json”},身体: {域:【“test-api-domain.com”)},json:真正的};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”)有效载荷=“{\“域\”:[\“test-api-domain.com”\]}”头= {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”,“内容类型”:“application / json”} conn.request (“职位”,“/网站/ 580 e63e98c9a982ac9b8b741 /发布”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/publish”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”请求(“内容类型”] =“application / json”请求。身体=“{\“域\”:[\“test-api-domain.com”\]}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”“弦”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/publish”有效载荷:=字符串。NewReader (“{\“域\”:[\“test-api-domain.com”\]}”) req, _:= http。NewRequest (“职位”(url,有效载荷)“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”) req.Header.Add (“内容类型”,“application / json”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/publish”);var请求=新RestRequest (Method.POST);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);请求。AddHeader (“内容类型”,“application / json”);请求。AddParameter (“application / json”,“{\“域\”:[\“test-api-domain.com”\]}”, ParameterType.RequestBody);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
域 |
身体 | (字符串) | 假 | 应该发布的域数组 |
响应
示例响应
{“排队”:真正的}
的名字 | 类型 | 描述 |
---|---|---|
排队 |
布尔 | 指示站点是否已排队等待发布 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
域列表
添加到指定站点的所有自定义域的列表
请求
获得/网站/: site_id/域
参数
壳牌的例子
curl -request GET \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/domains \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/domains”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“/网站/ 580 e63e98c9a982ac9b8b741 /域”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/domains”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/domains”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/domains”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
响应
示例响应
[{“_id”:“589 a331aa51e760df7ccb89d”,“名称”:“test-api-domain.com”},{“_id”:“589 a331aa51e760df7ccb89e”,“名称”:“www.test-api-domain.com”}]
的名字 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 域的唯一标识符 |
的名字 |
字符串 | 域名 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
集合
收藏列表
给定站点中所有集合的列表
请求
获得/网站/: site_id/集合
参数
壳牌的例子
curl -request GET \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/collections \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/collections”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“/网站/ 580 e63e98c9a982ac9b8b741 /集合”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/collections”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/collections”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/collections”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
响应
示例响应
[{“_id”:“580 e63fc8c9a982ac9b8b745”,“lastupdate”:“2016 - 10 - 24 t19:42:38.929z”,“createdOn”:“2016 - 10 - 24 t19:41:48.349z”,“名称”:“博客”,“鼻涕虫”:“职位”,“singularName”:“博客”},{“_id”:“580 e64088c9a982ac9b8b766”,“lastupdate”:“2016 - 10 - 24 t19:42:00.799z”,“createdOn”:“2016 - 10 - 24 t19:42:00.777z”,“名称”:“作者”,“鼻涕虫”:“作者”,“singularName”:“作者”}]
的名字 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 集合的唯一标识符 |
lastupdate |
字符串 | 集合最后一次更新的日期 |
createdOn |
字符串 | 创建集合的日期 |
的名字 |
字符串 | 给集合的名称 |
鼻涕虫 |
字符串 | 网站URL结构中的收集片段 |
singularName |
字符串 | 集合中一个项目的名称(如集合名为Posts,则为post) |
字段 |
[场] | 集合中的字段列表 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
获取集合
通过集合id获取集合
请求
获得/收藏/: collection_id
参数
壳牌的例子
curl -request GET \——url https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745 \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“/收藏/ 580 e63fc8c9a982ac9b8b745”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
collection_id |
路径 | 字符串 | 真正的 | 集合的唯一标识符 |
响应
示例响应
{“_id”:“580 e63fc8c9a982ac9b8b745”,“lastupdate”:“2016 - 10 - 24 t19:42:38.929z”,“createdOn”:“2016 - 10 - 24 t19:41:48.349z”,“名称”:“博客”,“鼻涕虫”:“职位”,“singularName”:“博客”,“字段”:[{“id”:“7 f62a9781291109b9e428fb47239fd35”,“可编辑”:真正的,“要求”:假,“类型”:“RichText”,“鼻涕虫”:“post”,“名称”:“后的身体”},{“验证”:{“单行模式”:假},“id”:“ac4ffead755a78c710c44042f528b073”,“helpText”:“出现在博客文章网格上的博客文章摘要”,“可编辑”:真正的,“要求”:假,“类型”:“明文”,“鼻涕虫”:“post-summary”,“名称”:“后总结”},{“id”:“ba1cfbdaa6b38b8e95e9b5063da8a5bd”,“可编辑”:真正的,“要求”:假,“类型”:“ImageRef”,“鼻涕虫”:“主图片”,“名称”:“主要形象”},{“id”:“a8c6ea29b08cc5b5ef966908fa1deae2”,“helpText”:用于博客帖子网格的主图片的小版本,“可编辑”:真正的,“要求”:假,“类型”:“ImageRef”,“鼻涕虫”:“缩略图”,“名称”:“缩略图”},{“id”:“87 e79a644a6fb5729940ec24e0012f01”,“可编辑”:真正的,“要求”:假,“类型”:“设置”,“innerType”:“ImageRef”,“鼻涕虫”:“画廊”,“名称”:“画廊”},{“id”:“1 e54974d97181032d3206ea021668e5f”,“可编辑”:真正的,“要求”:假,“类型”:“Bool”,“鼻涕虫”:“特色”,“名称”:“特色?”},{“id”:“648463 cbc042ab079c2b99430a398ae5”,“可编辑”:真正的,“要求”:假,“类型”:“颜色”,“鼻涕虫”:“颜色”,“名称”:“颜色”},{“验证”:{“collectionId”:“580 e64088c9a982ac9b8b766”},“id”:“ea9067c48edee510de71fe503fa2fb51”,“可编辑”:真正的,“要求”:假,“类型”:“ItemRef”,“鼻涕虫”:“作者”,“名称”:“作者”},{“验证”:{“最大长度”:256},“id”:“60 c0667e27b6d5a6daedec3a641265f6”,“可编辑”:真正的,“要求”:真正的,“类型”:“明文”,“鼻涕虫”:“名称”,“名称”:“名称”},{“验证”:{“消息”:{“最大长度”:"必须少于256个字符",“模式”:必须是字母数字,不包含任何空格或特殊字符},“模式”:{},“最大长度”:256},“id”:“8 f0c953df91d10b767d66e1d7d00d631”,“独一无二”:真正的,“可编辑”:真正的,“要求”:真正的,“类型”:“明文”,“鼻涕虫”:“鼻涕虫”,“名称”:“鼻涕虫”},{“默认”:假,“id”:“e4e92e700d70faffac6fa82ff2bfaece”,“可编辑”:真正的,“要求”:真正的,“类型”:“Bool”,“鼻涕虫”:“_archived”,“名称”:“存档”},{“默认”:假,“id”:“f2675b2ac4fcef746b24d4a320887ef8”,“可编辑”:真正的,“要求”:真正的,“类型”:“Bool”,“鼻涕虫”:“_draft”,“名称”:“草案”},{“id”:“0913 a35d92208bdf8fbf3ed1e39b771e”,“可编辑”:假,“要求”:假,“类型”:“日期”,“鼻涕虫”:“创建”,“名称”:“创建”},{“id”:“3 de04889465fe6d718e47b152ef5bb4d”,“可编辑”:假,“要求”:假,“类型”:“日期”,“鼻涕虫”:“更新”,“名称”:“更新”},{“id”:“2 a3cd866d5dbb294896130b233218626”,“可编辑”:假,“要求”:假,“类型”:“日期”,“鼻涕虫”:“发表”,“名称”:“发表”},{“id”:“62 c18561b9e89517751c6d8712d48f91”,“可编辑”:假,“要求”:假,“类型”:“用户”,“鼻涕虫”:“由”,“名称”:“由”},{“id”:“50918093 b4e4d4eca1e83c25bcdc06a4”,“可编辑”:假,“要求”:假,“类型”:“用户”,“鼻涕虫”:“更新”,“名称”:“更新”},{“id”:“5 c4587f18b32ef245daeaadfcba7860b”,“可编辑”:假,“要求”:假,“类型”:“用户”,“鼻涕虫”:“出版”,“名称”:“出版”}]}
的名字 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 集合的唯一标识符 |
lastupdate |
字符串 | 集合最后一次更新的日期 |
createdOn |
字符串 | 创建集合的日期 |
的名字 |
字符串 | 给集合的名称 |
鼻涕虫 |
字符串 | 网站URL结构中的收集片段 |
singularName |
字符串 | 集合中一个项目的名称(如集合名为Posts,则为post) |
字段 |
[场] | 集合中的字段列表 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
项目
收集项目列表
获取集合的所有项目
请求
获得/收藏/: collection_id/项目
参数
壳牌的例子
curl——请求GET \——url“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items?offset=0&limit=100”\——头“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items”,qs: {抵消:' 0 ',限制:“100”},头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“/收藏/ 580 e63fc8c9a982ac9b8b745 /物品吗?抵消= 0限制= 100”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items?offset=0&limit=100”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items?offset=0&limit=100”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items?offset=0&limit=100”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
collection_id |
路径 | 字符串 | 真正的 | 集合的唯一标识符 |
抵消 |
查询 | 数量 | 假 | 如果结果有超过限制的记录,则用于分页的偏移量 |
限制 |
查询 | 数量 | 假 | 返回的最大记录数(最大限制:100) |
响应
示例响应
{“项目”:[{“_archived”:假,“_draft”:假,“颜色”:“# a98080”,“名称”:“令人兴奋的博客标题”,“post”:“< p >博客内容…< / p > ",“post-summary”:“精彩博文摘要”,“主图片”:{“文件标识”:“580 e63fe8c9a982ac9b8b749”,“url”:“https://d1otoma47x30pg.cloudfront.net/580e63fc8c9a982ac9b8b744/580e63fe8c9a982ac9b8b749_1477338110257-image20.jpg”},“鼻涕虫”:“exciting-post”,“作者”:“580 e640c8c9a982ac9b8b778”,“更新”:“2016 - 11 - 15 - t22:45:32.647z”,“更新”:“Person_5660c5338e9d3b0bee3b86aa”,“创建”:“2016 - 11 - 15 - t22:45:32.647z”,“由”:“Person_5660c5338e9d3b0bee3b86aa”,“发表”:零,“出版”:零,“_cid”:“580 e63fc8c9a982ac9b8b745”,“_id”:“582 b900cba19143b2bb8a759”}],“数”:1,“限制”:1,“抵消”:0,“总”:5}
的名字 | 类型 | 描述 |
---|---|---|
项目 |
[CollectionItem] | 集合中的项列表 |
数 |
数量 | 退回物品数目 |
限制 |
数量 | 请求中指定的限制 |
抵消 |
数量 | 为分页指定的偏移量 |
总计 |
数量 | 集合中项目的总数 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
删除收藏物品
从集合中删除项当使用API删除CMS项时,默认的行为是从设计器或编辑器中的数据管理器中删除项。但是,也可以只从发布的站点删除项目。这将把设计器或编辑器中的项目设置为Draft状态。
请求
删除/收藏/: collection_id/项目
参数
壳牌的例子
curl——请求删除\——url“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items?live=true”\——头“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”\——头“application / json内容类型:\——数据“{"itemIds": ["62aa37923cf7a9de1ca4469c, 62aa37923cf7a9de1ca44697, 62aa37923cf7a9de1ca44696"]}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“删除”,url:“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items”,qs: {生活:“真正的”},头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”,“内容类型”:“application / json”},身体: {itemid:【“62年62 aa37923cf7a9de1ca4469c 62 aa37923cf7a9de1ca44697 aa37923cf7a9de1ca44696”)},json:真正的};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”)有效载荷=“{\“itemid \”:[\“aa37923cf7a9de1ca4469c 62, 62年62 aa37923cf7a9de1ca44697 aa37923cf7a9de1ca44696 \”]}”头= {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”,“内容类型”:“application / json”} conn.request (“删除”,“/收藏/ 580 e63fc8c9a982ac9b8b745 /物品吗?生活= true”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items?live=true”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::删除格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”请求(“内容类型”] =“application / json”请求。身体=“{\“itemid \”:[\“aa37923cf7a9de1ca4469c 62, 62年62 aa37923cf7a9de1ca44697 aa37923cf7a9de1ca44696 \”]}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”“弦”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items?live=true”有效载荷:=字符串。NewReader (“{\“itemid \”:[\“aa37923cf7a9de1ca4469c 62, 62年62 aa37923cf7a9de1ca44697 aa37923cf7a9de1ca44696 \”]}”) req, _:= http。NewRequest (“删除”(url,有效载荷)“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”) req.Header.Add (“内容类型”,“application / json”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items?live=true”);var请求=新RestRequest (Method.DELETE);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);请求。AddHeader (“内容类型”,“application / json”);请求。AddParameter (“application / json”,“{\“itemid \”:[\“aa37923cf7a9de1ca4469c 62, 62年62 aa37923cf7a9de1ca44697 aa37923cf7a9de1ca44696 \”]}”, ParameterType.RequestBody);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
collection_id |
路径 | 字符串 | 真正的 | 集合的唯一标识符 |
生活 |
查询 | 布尔 | 假 | 布尔值,指示是否将项目发布到/从活动站点发布 |
itemid |
身体 | (字符串) | 假 | 要删除或取消发布的项目id数组 |
响应
示例响应
{“deletedItemIds”:[“62 aa37923cf7a9de1ca4469c”,“62 aa37923cf7a9de1ca44697”,“62 aa37923cf7a9de1ca44696”],“错误”:[]}
的名字 | 类型 | 描述 |
---|---|---|
deletedItemIds |
(字符串) | 已删除项目id的数组 |
错误 |
(字符串) | 一系列的错误 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
创建集合项
创建一个新的集合项。要上传新图像,请将图像URL设置为对应项的字段。重用以前上传的图像的集合项可以引用它们的fileId属性。
请求
POST /收藏/: collection_id/项目
参数
壳牌的例子
curl——请求POST \——url“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items?live=true”\——头“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”\——头“application / json内容类型:\——数据{"fields": {"name": "Exciting blog post title", "slug": "Exciting -post", "_archived": false, "_draft": false, "color": "#a98080", "author": "580e640c8c9a982ac9b8b778", "post-body": " blog post content…
", "post- Summary ": "精彩博文摘要","main-image": "580e63fe8c9a982ac9b8b749"}}'
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“职位”,url:“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items”,qs: {生活:“真正的”},头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”,“内容类型”:“application / json”},身体: {字段: {的名字:“令人兴奋的博客标题”,鼻涕虫:“exciting-post”,_archived:假,_draft:假,颜色:“# a98080”,作者:580 e640c8c9a982ac9b8b778,“post”:' < p >博客内容…< / p > ',“post-summary”:“令人兴奋的博客文章摘要”,“主图片”:580 e63fe8c9a982ac9b8b749}},json:真正的};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”)有效载荷=”{\ \“字段”:{\“\”:\“激动人心的博客标题\”,\“鼻涕虫\”:\“exciting-post \”,\“_archived \”:假的,\“_draft \”:假的,\“颜色\”:\“# a98080 \”,\“\”作者:\“580 e640c8c9a982ac9b8b778 \”,\“post体\”:\“< p >博客内容…\",\"post- Summary \":\"精彩博客文章摘要\",\"main-image\":\"580e63fe8c9a982ac9b8b749\"}}"头= {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”,“内容类型”:“application / json”} conn.request (“职位”,“/收藏/ 580 e63fc8c9a982ac9b8b745 /物品吗?生活= true”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items?live=true”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”请求(“内容类型”] =“application / json”请求。身体=”{\ \“字段”:{\“\”:\“激动人心的博客标题\”,\“鼻涕虫\”:\“exciting-post \”,\“_archived \”:假的,\“_draft \”:假的,\“颜色\”:\“# a98080 \”,\“\”作者:\“580 e640c8c9a982ac9b8b778 \”,\“post体\”:\“< p >博客内容…\",\"post- Summary \":\"精彩博客文章摘要\",\"main-image\":\"580e63fe8c9a982ac9b8b749\"}}"Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”“弦”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items?live=true”有效载荷:=字符串。NewReader (”{\ \“字段”:{\“\”:\“激动人心的博客标题\”,\“鼻涕虫\”:\“exciting-post \”,\“_archived \”:假的,\“_draft \”:假的,\“颜色\”:\“# a98080 \”,\“\”作者:\“580 e640c8c9a982ac9b8b778 \”,\“post体\”:\“< p >博客内容…\",\"post- Summary \":\"精彩博客文章摘要\",\"main-image\":\"580e63fe8c9a982ac9b8b749\"}}") req, _:= http。NewRequest (“职位”(url,有效载荷)“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”) req.Header.Add (“内容类型”,“application / json”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items?live=true”);var请求=新RestRequest (Method.POST);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);请求。AddHeader (“内容类型”,“application / json”);请求。AddParameter (“application / json”,”{\ \“字段”:{\“\”:\“激动人心的博客标题\”,\“鼻涕虫\”:\“exciting-post \”,\“_archived \”:假的,\“_draft \”:假的,\“颜色\”:\“# a98080 \”,\“\”作者:\“580 e640c8c9a982ac9b8b778 \”,\“post体\”:\“< p >博客内容…\",\"post- Summary \":\"精彩博客文章摘要\",\"main-image\":\"580e63fe8c9a982ac9b8b749\"}}", ParameterType.RequestBody);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
collection_id |
路径 | 字符串 | 真正的 | 集合的唯一标识符 |
生活 |
查询 | 布尔 | 假 | 布尔值,指示是否将项目发布到/从活动站点发布 |
字段 |
身体 | 场 | 假 | 的实例场对象。 |
响应
示例响应
{“_archived”:假,“_draft”:假,“颜色”:“# a98080”,“名称”:“令人兴奋的博客标题”,“post”:“< p >博客内容…< / p > ",“post-summary”:“精彩博文摘要”,“主图片”:{“文件标识”:“580 e63fe8c9a982ac9b8b749”,“url”:“https://d1otoma47x30pg.cloudfront.net/580e63fc8c9a982ac9b8b744/580e63fe8c9a982ac9b8b749_1477338110257-image20.jpg”},“鼻涕虫”:“exciting-post”,“作者”:“580 e640c8c9a982ac9b8b778”,“更新”:“2016 - 11 - 15 - t22:45:32.647z”,“更新”:“Person_5660c5338e9d3b0bee3b86aa”,“创建”:“2016 - 11 - 15 - t22:45:32.647z”,“由”:“Person_5660c5338e9d3b0bee3b86aa”,“发表”:零,“出版”:零,“_cid”:“580 e63fc8c9a982ac9b8b745”,“_id”:“582 b900cba19143b2bb8a759”}
的名字 | 类型 | 描述 |
---|---|---|
_archived |
布尔 | 布尔值决定是否将项目设置为存档 |
_draft |
布尔 | 布尔值决定项目是否设置为draft |
_id |
字符串 | 项目的唯一标识符 |
_cid |
字符串 | 项目所属集合的唯一标识符 |
的名字 |
字符串 | 项目的名称 |
鼻涕虫 |
字符串 | 网站中项目的URL结构。注意:条目段代码的更新将中断所有引用旧段代码的链接。 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
发布收集物品
发布集合中的项。
请求
把/收藏/: collection_id/项目/出版
参数
壳牌的例子
请求PUT \——url https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/publish \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”\——头“application / json内容类型:\——数据“{"itemIds": ["62aa37923cf7a9de1ca4469c, 62aa37923cf7a9de1ca44697, 62aa37923cf7a9de1ca44696"]}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“把”,url:“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/publish”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”,“内容类型”:“application / json”},身体: {itemid:【“62年62 aa37923cf7a9de1ca4469c 62 aa37923cf7a9de1ca44697 aa37923cf7a9de1ca44696”)},json:真正的};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”)有效载荷=“{\“itemid \”:[\“aa37923cf7a9de1ca4469c 62, 62年62 aa37923cf7a9de1ca44697 aa37923cf7a9de1ca44696 \”]}”头= {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”,“内容类型”:“application / json”} conn.request (“把”,“/收藏/ 580 e63fc8c9a982ac9b8b745 /项目/发布”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/publish”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”请求(“内容类型”] =“application / json”请求。身体=“{\“itemid \”:[\“aa37923cf7a9de1ca4469c 62, 62年62 aa37923cf7a9de1ca44697 aa37923cf7a9de1ca44696 \”]}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”“弦”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/publish”有效载荷:=字符串。NewReader (“{\“itemid \”:[\“aa37923cf7a9de1ca4469c 62, 62年62 aa37923cf7a9de1ca44697 aa37923cf7a9de1ca44696 \”]}”) req, _:= http。NewRequest (“把”(url,有效载荷)“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”) req.Header.Add (“内容类型”,“application / json”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/publish”);var请求=新RestRequest (Method.PUT);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);请求。AddHeader (“内容类型”,“application / json”);请求。AddParameter (“application / json”,“{\“itemid \”:[\“aa37923cf7a9de1ca4469c 62, 62年62 aa37923cf7a9de1ca44697 aa37923cf7a9de1ca44696 \”]}”, ParameterType.RequestBody);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
collection_id |
路径 | 字符串 | 真正的 | 集合的唯一标识符 |
itemid |
身体 | (字符串) | 假 | 要发布的项目id数组 |
响应
示例响应
{“publishedItemIds”:[“62 aa37923cf7a9de1ca4469c”,“62 aa37923cf7a9de1ca44697”,“62 aa37923cf7a9de1ca44696”],“错误”:[]}
的名字 | 类型 | 描述 |
---|---|---|
publishedItemIds |
(字符串) | 已发布项id的数组 |
错误 |
(字符串) | 一系列的错误 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
更新收集项目
更新现有的集合项。要上传新图像,请将图像URL设置为对应项的字段。重用以前上传的图像的集合项可以引用它们的fileId属性。
请求
把/收藏/: collection_id/项目/: item_id
参数
壳牌的例子
curl——请求PUT \——url“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754?live=true”\——头“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”\——头“application / json内容类型:\——数据{"fields": {"name": "Exciting blog post title", "slug": "Exciting -post", "_archived": false, "_draft": false, "color": "#a98080", "author": "580e640c8c9a982ac9b8b778", "post-body": " blog post content…
", "post- Summary ": "精彩博文摘要","main-image": "580e63fe8c9a982ac9b8b749"}}'
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“把”,url:“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754”,qs: {生活:“真正的”},头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”,“内容类型”:“application / json”},身体: {字段: {的名字:“令人兴奋的博客标题”,鼻涕虫:“exciting-post”,_archived:假,_draft:假,颜色:“# a98080”,作者:580 e640c8c9a982ac9b8b778,“post”:' < p >博客内容…< / p > ',“post-summary”:“令人兴奋的博客文章摘要”,“主图片”:580 e63fe8c9a982ac9b8b749}},json:真正的};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”)有效载荷=”{\ \“字段”:{\“\”:\“激动人心的博客标题\”,\“鼻涕虫\”:\“exciting-post \”,\“_archived \”:假的,\“_draft \”:假的,\“颜色\”:\“# a98080 \”,\“\”作者:\“580 e640c8c9a982ac9b8b778 \”,\“post体\”:\“< p >博客内容…\",\"post- Summary \":\"精彩博客文章摘要\",\"main-image\":\"580e63fe8c9a982ac9b8b749\"}}"头= {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”,“内容类型”:“application / json”} conn.request (“把”,“/收藏/ 580 e63fc8c9a982ac9b8b745 /项目/ 580 e64008c9a982ac9b8b754 ?生活= true”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754?live=true”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”请求(“内容类型”] =“application / json”请求。身体=”{\ \“字段”:{\“\”:\“激动人心的博客标题\”,\“鼻涕虫\”:\“exciting-post \”,\“_archived \”:假的,\“_draft \”:假的,\“颜色\”:\“# a98080 \”,\“\”作者:\“580 e640c8c9a982ac9b8b778 \”,\“post体\”:\“< p >博客内容…\",\"post- Summary \":\"精彩博客文章摘要\",\"main-image\":\"580e63fe8c9a982ac9b8b749\"}}"Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”“弦”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754?live=true”有效载荷:=字符串。NewReader (”{\ \“字段”:{\“\”:\“激动人心的博客标题\”,\“鼻涕虫\”:\“exciting-post \”,\“_archived \”:假的,\“_draft \”:假的,\“颜色\”:\“# a98080 \”,\“\”作者:\“580 e640c8c9a982ac9b8b778 \”,\“post体\”:\“< p >博客内容…\",\"post- Summary \":\"精彩博客文章摘要\",\"main-image\":\"580e63fe8c9a982ac9b8b749\"}}") req, _:= http。NewRequest (“把”(url,有效载荷)“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”) req.Header.Add (“内容类型”,“application / json”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754?live=true”);var请求=新RestRequest (Method.PUT);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);请求。AddHeader (“内容类型”,“application / json”);请求。AddParameter (“application / json”,”{\ \“字段”:{\“\”:\“激动人心的博客标题\”,\“鼻涕虫\”:\“exciting-post \”,\“_archived \”:假的,\“_draft \”:假的,\“颜色\”:\“# a98080 \”,\“\”作者:\“580 e640c8c9a982ac9b8b778 \”,\“post体\”:\“< p >博客内容…\",\"post- Summary \":\"精彩博客文章摘要\",\"main-image\":\"580e63fe8c9a982ac9b8b749\"}}", ParameterType.RequestBody);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
collection_id |
路径 | 字符串 | 真正的 | 集合的唯一标识符 |
item_id |
路径 | 字符串 | 真正的 | 和项的唯一标识符 |
生活 |
查询 | 布尔 | 假 | 布尔值,指示是否将项目发布到/从活动站点发布 |
字段 |
身体 | 场 | 假 | 的实例场对象。 |
响应
示例响应
{“_archived”:假,“_draft”:假,“颜色”:“# a98080”,“名称”:“令人兴奋的博客标题”,“post”:“< p >博客内容…< / p > ",“post-summary”:“精彩博文摘要”,“主图片”:{“文件标识”:“580 e63fe8c9a982ac9b8b749”,“url”:“https://d1otoma47x30pg.cloudfront.net/580e63fc8c9a982ac9b8b744/580e63fe8c9a982ac9b8b749_1477338110257-image20.jpg”},“鼻涕虫”:“exciting-post”,“作者”:“580 e640c8c9a982ac9b8b778”,“更新”:“2016 - 11 - 15 - t22:45:32.647z”,“更新”:“Person_5660c5338e9d3b0bee3b86aa”,“创建”:“2016 - 11 - 15 - t22:45:32.647z”,“由”:“Person_5660c5338e9d3b0bee3b86aa”,“发表”:零,“出版”:零,“_cid”:“580 e63fc8c9a982ac9b8b745”,“_id”:“582 b900cba19143b2bb8a759”}
的名字 | 类型 | 描述 |
---|---|---|
_archived |
布尔 | 布尔值决定是否将项目设置为存档 |
_draft |
布尔 | 布尔值决定项目是否设置为draft |
_id |
字符串 | 项目的唯一标识符 |
_cid |
字符串 | 项目所属集合的唯一标识符 |
的名字 |
字符串 | 项目的名称 |
鼻涕虫 |
字符串 | 网站中项目的URL结构。注意:条目段代码的更新将中断所有引用旧段代码的链接。 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
补丁收集项目
只更新需要更改的字段。要上传新图像,请将图像URL设置为对应项的字段。重用以前上传的图像的集合项可以引用它们的fileId属性。
请求
补丁/收藏/: collection_id/项目/: item_id
参数
壳牌的例子
curl——请求补丁\——url“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754?live=true”\——头“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”\——头“application / json内容类型:\——数据{"fields": {"name": "Exciting blog post title", "slug": "Exciting -post", "_archived": false, "_draft": false, "color": "#a98080", "author": "580e640c8c9a982ac9b8b778", "post-body": " blog post content…
", "post- Summary ": "精彩博文摘要","main-image": "580e63fe8c9a982ac9b8b749"}}'
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“补丁”,url:“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754”,qs: {生活:“真正的”},头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”,“内容类型”:“application / json”},身体: {字段: {的名字:“令人兴奋的博客标题”,鼻涕虫:“exciting-post”,_archived:假,_draft:假,颜色:“# a98080”,作者:580 e640c8c9a982ac9b8b778,“post”:' < p >博客内容…< / p > ',“post-summary”:“令人兴奋的博客文章摘要”,“主图片”:580 e63fe8c9a982ac9b8b749}},json:真正的};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”)有效载荷=”{\ \“字段”:{\“\”:\“激动人心的博客标题\”,\“鼻涕虫\”:\“exciting-post \”,\“_archived \”:假的,\“_draft \”:假的,\“颜色\”:\“# a98080 \”,\“\”作者:\“580 e640c8c9a982ac9b8b778 \”,\“post体\”:\“< p >博客内容…\",\"post- Summary \":\"精彩博客文章摘要\",\"main-image\":\"580e63fe8c9a982ac9b8b749\"}}"头= {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”,“内容类型”:“application / json”} conn.request (“补丁”,“/收藏/ 580 e63fc8c9a982ac9b8b745 /项目/ 580 e64008c9a982ac9b8b754 ?生活= true”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754?live=true”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::补丁格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”请求(“内容类型”] =“application / json”请求。身体=”{\ \“字段”:{\“\”:\“激动人心的博客标题\”,\“鼻涕虫\”:\“exciting-post \”,\“_archived \”:假的,\“_draft \”:假的,\“颜色\”:\“# a98080 \”,\“\”作者:\“580 e640c8c9a982ac9b8b778 \”,\“post体\”:\“< p >博客内容…\",\"post- Summary \":\"精彩博客文章摘要\",\"main-image\":\"580e63fe8c9a982ac9b8b749\"}}"Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”“弦”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754?live=true”有效载荷:=字符串。NewReader (”{\ \“字段”:{\“\”:\“激动人心的博客标题\”,\“鼻涕虫\”:\“exciting-post \”,\“_archived \”:假的,\“_draft \”:假的,\“颜色\”:\“# a98080 \”,\“\”作者:\“580 e640c8c9a982ac9b8b778 \”,\“post体\”:\“< p >博客内容…\",\"post- Summary \":\"精彩博客文章摘要\",\"main-image\":\"580e63fe8c9a982ac9b8b749\"}}") req, _:= http。NewRequest (“补丁”(url,有效载荷)“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”) req.Header.Add (“内容类型”,“application / json”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754?live=true”);var请求=新RestRequest (Method.PATCH);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);请求。AddHeader (“内容类型”,“application / json”);请求。AddParameter (“application / json”,”{\ \“字段”:{\“\”:\“激动人心的博客标题\”,\“鼻涕虫\”:\“exciting-post \”,\“_archived \”:假的,\“_draft \”:假的,\“颜色\”:\“# a98080 \”,\“\”作者:\“580 e640c8c9a982ac9b8b778 \”,\“post体\”:\“< p >博客内容…\",\"post- Summary \":\"精彩博客文章摘要\",\"main-image\":\"580e63fe8c9a982ac9b8b749\"}}", ParameterType.RequestBody);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
collection_id |
路径 | 字符串 | 真正的 | 集合的唯一标识符 |
item_id |
路径 | 字符串 | 真正的 | 和项的唯一标识符 |
生活 |
查询 | 布尔 | 假 | 布尔值,指示是否将项目发布到/从活动站点发布 |
字段 |
身体 | 场 | 假 | 的实例场对象。 |
响应
示例响应
{“_archived”:假,“_draft”:假,“颜色”:“# a98080”,“名称”:“令人兴奋的博客标题”,“post”:“< p >博客内容…< / p > ",“post-summary”:“精彩博文摘要”,“主图片”:{“文件标识”:“580 e63fe8c9a982ac9b8b749”,“url”:“https://d1otoma47x30pg.cloudfront.net/580e63fc8c9a982ac9b8b744/580e63fe8c9a982ac9b8b749_1477338110257-image20.jpg”},“鼻涕虫”:“exciting-post”,“作者”:“580 e640c8c9a982ac9b8b778”,“更新”:“2016 - 11 - 15 - t22:45:32.647z”,“更新”:“Person_5660c5338e9d3b0bee3b86aa”,“创建”:“2016 - 11 - 15 - t22:45:32.647z”,“由”:“Person_5660c5338e9d3b0bee3b86aa”,“发表”:零,“出版”:零,“_cid”:“580 e63fc8c9a982ac9b8b745”,“_id”:“582 b900cba19143b2bb8a759”}
的名字 | 类型 | 描述 |
---|---|---|
_archived |
布尔 | 布尔值决定是否将项目设置为存档 |
_draft |
布尔 | 布尔值决定项目是否设置为draft |
_id |
字符串 | 项目的唯一标识符 |
_cid |
字符串 | 项目所属集合的唯一标识符 |
的名字 |
字符串 | 项目的名称 |
鼻涕虫 |
字符串 | 网站中项目的URL结构。注意:条目段代码的更新将中断所有引用旧段代码的链接。 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
得到收集项目
获取集合中的一个项目
请求
获得/收藏/: collection_id/项目/: item_id
参数
壳牌的例子
curl -request GET \——url https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754 \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“/收藏/ 580 e63fc8c9a982ac9b8b745 /项目/ 580 e64008c9a982ac9b8b754”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
collection_id |
路径 | 字符串 | 真正的 | 集合的唯一标识符 |
item_id |
路径 | 字符串 | 真正的 | 和项的唯一标识符 |
响应
示例响应
{“项目”:[{“_archived”:假,“_draft”:假,“颜色”:“# a98080”,“名称”:“令人兴奋的博客标题”,“post”:“< p >博客内容…< / p > ",“post-summary”:“精彩博文摘要”,“主图片”:{“文件标识”:“580 e63fe8c9a982ac9b8b749”,“url”:“https://d1otoma47x30pg.cloudfront.net/580e63fc8c9a982ac9b8b744/580e63fe8c9a982ac9b8b749_1477338110257-image20.jpg”},“鼻涕虫”:“exciting-post”,“作者”:“580 e640c8c9a982ac9b8b778”,“更新”:“2016 - 11 - 15 - t22:45:32.647z”,“更新”:“Person_5660c5338e9d3b0bee3b86aa”,“创建”:“2016 - 11 - 15 - t22:45:32.647z”,“由”:“Person_5660c5338e9d3b0bee3b86aa”,“发表”:零,“出版”:零,“_cid”:“580 e63fc8c9a982ac9b8b745”,“_id”:“582 b900cba19143b2bb8a759”}],“数”:1,“限制”:1,“抵消”:0,“总”:5}
的名字 | 类型 | 描述 |
---|---|---|
项目 |
[CollectionItem] | 集合中的项列表 |
数 |
数量 | 退回物品数目 |
限制 |
数量 | 请求中指定的限制 |
抵消 |
数量 | 为分页指定的偏移量 |
总计 |
数量 | 集合中项目的总数 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
删除收藏物品
当使用API删除CMS项时,默认行为会从设计器或编辑器中的数据管理器中删除该项。但是,也可以只从发布的站点删除该项。这将把设计器或编辑器中的项目设置为Draft状态。
请求
删除/收藏/: collection_id/项目/: item_id
参数
壳牌的例子
curl——请求删除\——url“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754?live=true”\——头“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“删除”,url:“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754”,qs: {生活:“真正的”},头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“删除”,“/收藏/ 580 e63fc8c9a982ac9b8b745 /项目/ 580 e64008c9a982ac9b8b754 ?生活= true”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754?live=true”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::删除格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754?live=true”Req, _:= http。NewRequest (“删除”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754?live=true”);var请求=新RestRequest (Method.DELETE);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
collection_id |
路径 | 字符串 | 真正的 | 集合的唯一标识符 |
item_id |
路径 | 字符串 | 真正的 | 和项的唯一标识符 |
生活 |
查询 | 布尔 | 假 | 布尔值,指示是否将项目发布到/从活动站点发布 |
响应
示例响应
{“删除”:1}
的名字 | 类型 | 描述 |
---|---|---|
删除 |
数量 | 删除的记录数量 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
用户
用户列表
获取站点的用户列表
请求
获得/网站/: site_id/用户
参数
壳牌的例子
curl——请求GET \——url“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users?offset=0&limit=100&sort=CreatedOn”\——头“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users”,qs: {抵消:' 0 ',限制:“100”,排序:“CreatedOn”},头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“e63e98c9a982ac9b8b741 /用户/网站/ 580 ?抵消= 0限制= 100种= CreatedOn”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users?offset=0&limit=100&sort=CreatedOn”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users?offset=0&limit=100&sort=CreatedOn”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users?offset=0&limit=100&sort=CreatedOn”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
抵消 |
查询 | 数量 | 假 | 如果结果有超过限制的记录,则用于分页的偏移量 |
限制 |
查询 | 数量 | 假 | 返回的最大记录数(最大限制:100) |
排序 |
查询 | 字符串 | 假 | 对用户排序时使用的排序字符串 示例( CreatedOn ,电子邮件 ,状态 ,LastLogin ,UpdatedOn ).可以加前缀 - 反转排序(例如)。-CreatedOn ) |
响应
示例响应
{“用户”:[{“_id”:“6287 ec36a841b25637c663df”,“createdOn”:“2022 - 05 - 20 - t13:46:12.093z”,“updatedOn”:“2022 - 05 - 20 - t13:46:12.093z”,“emailVerified”:假,“状态”:“未经证实的”,“数据”:{“accept-privacy”:假,“accept-communications”:假,“电子邮件”:“Person.One@home.com”,“名称”:“人”}},{“_id”:“6287 ec36a841b25637c663f0”,“createdOn”:“2022 - 05 - 19 t05:32:04.581z”,“updatedOn”:“2022 - 05 - 19 t05:32:04.581z”,“emailVerified”:假,“状态”:“未经证实的”,“数据”:{“accept-privacy”:假,“accept-communications”:假,“电子邮件”:“Person.Two@home.com”,“名称”:“二人”}},{“_id”:“6287 ec36a841b25637c663d9”,“createdOn”:“2022 - 05 - 17 t03:34:06.720z”,“updatedOn”:“2022 - 05 - 17 t03:34:06.720z”,“emailVerified”:真正的,“状态”:“验证”,“数据”:{“accept-privacy”:假,“accept-communications”:假,“电子邮件”:“Person.Three@home.com”,“名称”:“三人”}},{“_id”:“6287 ec37a841b25637c6641b”,“createdOn”:“2022 - 05 - 15 - t03:46:09.748z”,“updatedOn”:“2022 - 05 - 15 - t03:46:09.748z”,“emailVerified”:假,“状态”:“未经证实的”,“数据”:{“accept-privacy”:假,“accept-communications”:假,“电子邮件”:“Person.Four@home.com”,“名称”:“四人”}},{“_id”:“6287 ec37a841b25637c66449”,“createdOn”:“2022 - 05 - 15 - t02:55:38.786z”,“updatedOn”:“2022 - 05 - 15 - t02:55:38.786z”,“emailVerified”:真正的,“状态”:“验证”,“数据”:{“accept-privacy”:假,“accept-communications”:假,“电子邮件”:“Person.Five@home.com”,“名称”:“五人”}}],“数”:5,“限制”:5,“抵消”:0,“总”:201}
的名字 | 类型 | 描述 |
---|---|---|
数 |
数量 | 返回的用户数量 |
限制 |
数量 | 请求中指定的限制 |
抵消 |
数量 | 为分页指定的偏移量 |
总计 |
数量 | 集合中的用户总数 |
用户 |
[用户] | 一个网站的用户列表 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
获取用户
通过id获取一个用户
请求
获得/网站/: site_id/用户/: user_id
参数
壳牌的例子
curl -request GET \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/580e63e98c9a982ac9b8b741 \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/580e63e98c9a982ac9b8b741”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“/网站/ 580 e63e98c9a982ac9b8b741 /用户/ 580 e63e98c9a982ac9b8b741”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/580e63e98c9a982ac9b8b741”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/580e63e98c9a982ac9b8b741”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/580e63e98c9a982ac9b8b741”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
user_id |
路径 | 字符串 | 真正的 | 用户的唯一标识符 |
响应
示例响应
{“_id”:“6287 ec36a841b25637c663df”,“createdOn”:“2022 - 05 - 20 - t13:46:12.093z”,“updatedOn”:“2022 - 05 - 20 - t13:46:12.093z”,“emailVerified”:真正的,“状态”:“验证”,“数据”:{“accept-privacy”:假,“accept-communications”:假,“电子邮件”:“Some.One@home.com”,“名称”:“一些人”}}
的名字 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 用户的唯一标识符 |
createdOn |
字符串 | 创建用户的时间戳 |
updatedOn |
字符串 | 更新用户的时间戳 |
invitedOn |
字符串 | 邀请用户的时间戳 |
lastLogin |
字符串 | 用户登录的时间戳 |
emailVerified |
布尔 | 显示用户是否已验证其电子邮件地址 |
状态 |
字符串 | 用户的状态 |
数据 |
对象 | 包含用户的基本信息和自定义字段的对象 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
更新用户
按id更新用户
请求
补丁/网站/: site_id/用户/: user_id
参数
壳牌的例子
curl -request PATCH \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/580e63e98c9a982ac9b8b741 \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”\——头“application / json内容类型:\——数据“{"accept-privacy": false, "accept-communications": false, "name": "Some One"}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“补丁”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/580e63e98c9a982ac9b8b741”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”,“内容类型”:“application / json”},身体: {“accept-privacy”:假,“accept-communications”:假,的名字:“一个人”},json:真正的};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”)有效载荷=“{\“accept-privacy \”:假的,\“accept-communications \”:假的,\“\”:\“\”}”头= {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”,“内容类型”:“application / json”} conn.request (“补丁”,“/网站/ 580 e63e98c9a982ac9b8b741 /用户/ 580 e63e98c9a982ac9b8b741”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/580e63e98c9a982ac9b8b741”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::补丁格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”请求(“内容类型”] =“application / json”请求。身体=“{\“accept-privacy \”:假的,\“accept-communications \”:假的,\“\”:\“\”}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”“弦”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/580e63e98c9a982ac9b8b741”有效载荷:=字符串。NewReader (“{\“accept-privacy \”:假的,\“accept-communications \”:假的,\“\”:\“\”}”) req, _:= http。NewRequest (“补丁”(url,有效载荷)“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”) req.Header.Add (“内容类型”,“application / json”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/580e63e98c9a982ac9b8b741”);var请求=新RestRequest (Method.PATCH);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);请求。AddHeader (“内容类型”,“application / json”);请求。AddParameter (“application / json”,“{\“accept-privacy \”:假的,\“accept-communications \”:假的,\“\”:\“\”}”, ParameterType.RequestBody);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
user_id |
路径 | 字符串 | 真正的 | 用户的唯一标识符 |
数据 |
身体 | 对象 | 假 | 用户更新的数据字段 |
响应
示例响应
{“_id”:“6287 ec36a841b25637c663df”,“createdOn”:“2022 - 05 - 20 - t13:46:12.093z”,“updatedOn”:“2022 - 05 - 20 - t13:46:12.093z”,“emailVerified”:真正的,“状态”:“验证”,“数据”:{“accept-privacy”:假,“accept-communications”:假,“电子邮件”:“Some.One@home.com”,“名称”:“一些人”}}
的名字 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 用户的唯一标识符 |
createdOn |
字符串 | 创建用户的时间戳 |
updatedOn |
字符串 | 更新用户的时间戳 |
invitedOn |
字符串 | 邀请用户的时间戳 |
lastLogin |
字符串 | 用户登录的时间戳 |
emailVerified |
布尔 | 显示用户是否已验证其电子邮件地址 |
状态 |
字符串 | 用户的状态 |
数据 |
对象 | 包含用户的基本信息和自定义字段的对象 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
删除用户
按id删除用户
请求
删除/网站/: site_id/用户/: user_id
参数
壳牌的例子
请求删除\——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/580e63e98c9a982ac9b8b741 \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“删除”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/580e63e98c9a982ac9b8b741”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“删除”,“/网站/ 580 e63e98c9a982ac9b8b741 /用户/ 580 e63e98c9a982ac9b8b741”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/580e63e98c9a982ac9b8b741”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::删除格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/580e63e98c9a982ac9b8b741”Req, _:= http。NewRequest (“删除”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/580e63e98c9a982ac9b8b741”);var请求=新RestRequest (Method.DELETE);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
user_id |
路径 | 字符串 | 真正的 | 用户的唯一标识符 |
响应
示例响应
{“删除”:1}
的名字 | 类型 | 描述 |
---|---|---|
删除 |
数量 | 删除的记录数量 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
邀请用户
通过电子邮件地址邀请用户
请求
POST /网站/: site_id/用户/邀请
参数
壳牌的例子
请求POST \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/invite \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”\——头“application / json内容类型:\——数据{“电子邮件”:“some.one@home.com”,“access_groups”:[" webflowers "]}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“职位”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/invite”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”,“内容类型”:“application / json”},身体: {电子邮件:“some.one@home.com”,access_groups:【“webflowers”)},json:真正的};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”)有效载荷=“{\“邮件\”,\“some.one@home.com \”,\“access_groups \”:[\“webflowers \]}”头= {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”,“内容类型”:“application / json”} conn.request (“职位”,“/网站/ 580 e63e98c9a982ac9b8b741 /用户/邀请”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/invite”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”请求(“内容类型”] =“application / json”请求。身体=“{\“邮件\”,\“some.one@home.com \”,\“access_groups \”:[\“webflowers \]}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”“弦”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/invite”有效载荷:=字符串。NewReader (“{\“邮件\”,\“some.one@home.com \”,\“access_groups \”:[\“webflowers \]}”) req, _:= http。NewRequest (“职位”(url,有效载荷)“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”) req.Header.Add (“内容类型”,“application / json”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/invite”);var请求=新RestRequest (Method.POST);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);请求。AddHeader (“内容类型”,“application / json”);请求。AddParameter (“application / json”,“{\“邮件\”,\“some.one@home.com \”,\“access_groups \”:[\“webflowers \]}”, ParameterType.RequestBody);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
电子邮件 |
身体 | 字符串 | 假 | 发送邀请的用户的电子邮件地址 |
access_groups |
身体 | (字符串) | 假 | 访问组段塞的数组 |
响应
示例响应
{“_id”:“6287 ec36a841b25637c663df”,“createdOn”:“2022 - 05 - 20 - t13:46:12.093z”,“updatedOn”:“2022 - 05 - 20 - t13:46:12.093z”,“emailVerified”:真正的,“状态”:“验证”,“数据”:{“accept-privacy”:假,“accept-communications”:假,“电子邮件”:“Some.One@home.com”,“名称”:“一些人”}}
的名字 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 用户的唯一标识符 |
createdOn |
字符串 | 创建用户的时间戳 |
updatedOn |
字符串 | 更新用户的时间戳 |
invitedOn |
字符串 | 邀请用户的时间戳 |
lastLogin |
字符串 | 用户登录的时间戳 |
emailVerified |
布尔 | 显示用户是否已验证其电子邮件地址 |
状态 |
字符串 | 用户的状态 |
数据 |
对象 | 包含用户的基本信息和自定义字段的对象 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
访问组列表
获取站点的访问组列表
请求
获得/网站/: site_id/用户/ accessgroups
参数
壳牌的例子
curl——请求GET \——url“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/accessgroups?offset=0&limit=100&sort=CreatedOn”\——头“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/accessgroups”,qs: {抵消:' 0 ',限制:“100”,排序:“CreatedOn”},头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“/网站/ 580 e63e98c9a982ac9b8b741 /用户/ accessgroups吗?抵消= 0限制= 100种= CreatedOn”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/accessgroups?offset=0&limit=100&sort=CreatedOn”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/accessgroups?offset=0&limit=100&sort=CreatedOn”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/users/accessgroups?offset=0&limit=100&sort=CreatedOn”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
抵消 |
查询 | 数量 | 假 | 如果结果有超过限制的记录,则用于分页的偏移量 |
限制 |
查询 | 数量 | 假 | 返回的最大记录数(最大限制:100) |
排序 |
查询 | 字符串 | 假 | 对访问组排序时使用的字符串进行排序 可以加前缀 - 反转排序(例如)。-CreatedOn ) |
响应
示例响应
{“accessGroups”:[{“_id”:“62 be58d404be8a6cc900c081”,“名称”:“Webflowers”,“shortId”:“乔”,“鼻涕虫”:“webflowers”,“createdOn”:“2022 - 08 - 01 - t19:41:48.349z”}],“数”:1,“限制”:10,“抵消”:0,“总”:1}
的名字 | 类型 | 描述 |
---|---|---|
数 |
数量 | 返回的访问组数量 |
限制 |
数量 | 请求中指定的限制 |
抵消 |
数量 | 为分页指定的偏移量 |
总计 |
数量 | 集合中访问组的总数 |
accessGroups |
[AccessGroup] | 网站访问组列表 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
欧宝体育在线首页产品& sku
列出产品和欧宝体育在线首页sku
检索一个站点的所有产品。欧宝体育在线首页使用限制
而且抵消
对具有后续请求的所有产品进行分页。欧宝体育在线首页每个产品的所有sku也将被提取和返回欧宝体育在线首页。的数
,限制
而且抵消
而且总计
值仅代表产品,不包括任何sku。欧宝体育在线首页
请求
获得/网站/: site_id/欧宝体育在线首页产品
参数
壳牌的例子
curl——请求GET \——url“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products?offset=0&limit=100”\——头“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products”,qs: {抵消:' 0 ',限制:“100”},头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“/网站/ 580 e63e98c9a982ac9b8b741 /欧宝体育在线首页产品?抵消= 0限制= 100”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products?offset=0&limit=100”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products?offset=0&limit=100”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products?offset=0&limit=100”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
抵消 |
查询 | 数量 | 假 | 如果结果有超过限制的记录,则用于分页的偏移量 |
限制 |
查询 | 数量 | 假 | 返回的最大记录数(最大限制:100) |
响应
示例响应
{“项目”:[{“欧宝体育在线首页产品”:{“可交付”:真正的,“_archived”:假,“_draft”:假,“名称”:“隐形斗篷”,“ec-欧宝体育在线首页product-type”:“ff42fee0113744f693a764e3431a9cc2”,“sku-properties”:[{“id”:“a37a7991f7ca1be0d349a805a2bddb5b”,“名称”:“颜色”,“枚举”:[{“id”:“a9506da8e70a8b087f35a4094ec34a53”,“名称”:“黑曜石黑”,“鼻涕虫”:“obsidian-black”},{“id”:“c92a465a1298c95fd1cd7f4c1c96c2ba”,“名称”:“烟灰色”,“鼻涕虫”:“smoke-grey”},{“id”:“ef9511c0b56cc11ff47c5669f65030b4”,“名称”:“森林绿”,“鼻涕虫”:“森林绿”}]}],“描述”:"一种能让穿着者隐形的斗篷",“鼻涕虫”:“cloak-of-invisibility-1”,“更新”:“2020 - 04 - 01 - t22:40:19.329z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 01 - t22:40:17.602z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“default-sku”:“5 e8518536e147040726cc416”,“_cid”:“5 dd44c493543b37d5449b3a5”,“_id”:“5 e8518516e147040726cc415”},“sku”:[{“价格”:{“单元”:“美元”,“价值”:120000},“_archived”:假,“_draft”:假,“sku-values”:{},“宽度”:56,“长度”:0.3,“高度”:72,“重量”:24,“名称”:隐形斗篷颜色:黑曜石黑,“主图片”:{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零},“更多的图片”:[{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零},{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零}],“下载文件”:[{“id”:“5 ebb1676c3244c2c6ae18814”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“https://dropbox.com/files/modern-web-design-process.pdf”}],“鼻涕虫”:“cloak-of-invisibility-color-obsidian-black-7”,“欧宝体育在线首页产品”:“5 e8518516e147040726cc415”,“更新”:“2020 - 04 - 01 - t22:40:19.287z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 01 - t22:40:19.287z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“_cid”:“5 dd44c493543b37d5449b383”,“_id”:“5 e8518536e147040726cc416”}]}],“数”:1,“限制”:One hundred.,“抵消”:0,“总”:12}
的名字 | 类型 | 描述 |
---|---|---|
项目 |
[欧宝体育在线首页] | 集合内的项目对象列表。包含产品和skus欧宝体育在线首页密钥 |
数 |
数量 | 退回物品数目 |
限制 |
数量 | 请求中指定的限制 |
抵消 |
数量 | 为分页指定的偏移量 |
总计 |
数量 | 集合中项目的总数 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
创建产品和SK欧宝体育在线首页U
添加一个新产品涉及创建一个欧宝体育在线首页产品项和一个SKU项,因为一个产品项至少必须有一个SKU项。
要创建具有多个sku的新Prod欧宝体育在线首页uct,您必须:
- 使用此端点创建Prod欧宝体育在线首页uct和Default SKU,确保添加
sku-properties
在产品数据中。欧宝体育在线首页 - 你不能添加
sku-values
到SKU,因为还没有创建enum id。当这个端点返回时,它将为sku-properties
枚举。 - 使用这些id,更新默认的有效SKU
sku-values
并创建任何额外的sku(如果需要),具有有效的sku-values
. - 您也可以创建没有欧宝体育在线首页
sku-properties
稍后再添加它们。 - 如果你添加任何
sku
属性,默认SKU将默认为每个选项的第一个值。
在创建时,默认的产品类型将是欧宝体育在线首页先进的
.的产品类欧宝体育在线首页型用于确定向用户显示哪个product和SKU字段设计师
和编辑器
.设置它先进的
确保所有Product和SKU字段欧宝体育在线首页都将显示出来。中的产品欧宝体育在线首页类型可以编辑设计师
或者是编辑器
.
请求
POST /网站/: site_id/欧宝体育在线首页产品
参数
壳牌的例子
请求POST \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/products \——头文欧宝体育在线首页件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”\——头“application / json内容类型:\——数据{“产品欧宝体育在线首页”:{“可交付”:真的,“_archived”:假的,“_draft”:假的,“名字”:“隐形斗篷”,“ec-product-type”:“ff42fee0113744f693a764e3431a9cc2”,“sku-properties”:[{" id ":“a37a7991f7ca1be0d349a805a2bddb5b”,“名字”:“颜色”,“枚举”:[{" id ":“a9506da8e70a8b087f35a4094ec34a53”,“名字”:“黑曜石黑”,“鼻涕虫”:“obsidian-black”},{" id ":“c92a465a1298c95fd1cd7f4c1c96c2ba”,“名字”:“烟灰色”,“鼻涕虫”:“smoke-grey”},{" id ":“ef9511c0b56cc11ff47c5669f65030b4”,“名字”:"Forest Green", "slug": "Forest - Green"}]}], "description": "隐形斗篷","slug": "隐身斗篷-1","updated-on": "2020-04-01T22:40:19.329Z", "updated-by": "Person_5d8fcb6d94dd1853060fb3b3", "created-on": "Person_5d8fcb6d94dd1853060fb3b3", "created-by": "Person_5d8fcb6d94dd1853060fb3b3", "created-by": "Person_5d8fcb6d94dd1853060fb3b3", "created-on": "Person_5d8fcb6d94dd1853060fb3b3", "default-sku": "5e8518536e147040726cc416", "_cid": "5dd44c493543b37d5449b3a5", "_id":"5e8518516e147040726cc415"}, "sku": {"price": {"unit": "USD", "value": 120000}, "_archived": false, "_draft": false, "sku-values": {}, "width": 56, "length": 0.3, "height": 72, "weight": 24, "name": "隐身斗篷颜色:黑黑","main-image": {"fileId": "5e85161dabd9ea4072cf1414", "url": "https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg", "alt": null}, "more-images":[{"”:“5 e85161dabd9ea4072cf1414”、“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零},{"”:“5 e85161dabd9ea4072cf1414”、“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零}],“下载文件”:[{" id ":“5 ebb1676c3244c2c6ae18814”,“名字”:"现代网页设计过程- Webflow book.pdf", "url": "https://dropbox.com/files/modern-web-design-process.pdf"}], "slug": " cloakof - invisible -color-obsidian-black-7", "product": "5e8518516e1470欧宝体育在线首页40726cc415", "updated-on": "2020-04-01T22:40:19.287Z", "updated-by": "Person_5d8fcb6d94dd1853060fb3b3", "created-by": "Person_5d8fcb6d94dd1853060fb3b3", "_cid": "5dd44c493543b37d5449b383", "_id": "“5 e8518536e147040726cc416“}}
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“职位”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”,“内容类型”:“application / json”},身体: {欧宝体育在线首页: {可交付:真正的,_archived:假,_draft:假,的名字:“隐形斗篷”,“ec-欧宝体育在线首页product-type”:“ff42fee0113744f693a764e3431a9cc2”,“sku-properties”: [{id:“a37a7991f7ca1be0d349a805a2bddb5b”,的名字:“颜色”,枚举: [{id:“a9506da8e70a8b087f35a4094ec34a53”,的名字:黑曜石黑的,鼻涕虫:“obsidian-black”}, {id:“c92a465a1298c95fd1cd7f4c1c96c2ba”,的名字:烟灰色的,鼻涕虫:“smoke-grey”}, {id:“ef9511c0b56cc11ff47c5669f65030b4”,的名字:“森林绿”,鼻涕虫:“森林绿”}]}],描述:一件能让穿着者隐形的斗篷,鼻涕虫:“cloak-of-invisibility-1”,“更新”:2020 - 04 - 01 t22:40:19.329z,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:2020 - 04 - 01 t22:40:17.602z,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“default-sku”:“5 e8518536e147040726cc416”,_cid:“5 dd44c493543b37d5449b3a5”,_id:“5 e8518516e147040726cc415”},sku: {价格: {单位:“美元”,价值:120000},_archived:假,_draft:假,“sku-values”: {},宽度:56,长度:0.3,高度:72,重量:24,的名字:隐形斗篷颜色:黑曜石黑,“主图片”: {文件标识:“5 e85161dabd9ea4072cf1414”,url:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,alt:零},更多的图片的: [{文件标识:“5 e85161dabd9ea4072cf1414”,url:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,alt:零}, {文件标识:“5 e85161dabd9ea4072cf1414”,url:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,alt:零}),“下载文件”: [{id:“5 ebb1676c3244c2c6ae18814”,的名字:“现代网页设计过程- Webflow电子书。pdf”,url:“https://dropbox.com/files/modern-web-design-process.pdf”}),鼻涕虫:“cloak-of-invisibility-color-obsidian-black-7”,欧宝体育在线首页:“5 e8518516e147040726cc415”,“更新”:2020 - 04 - 01 t22:40:19.287z,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:2020 - 04 - 01 t22:40:19.287z,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,_cid:“5 dd44c493543b37d5449b383”,_id:“5 e8518536e147040726cc416”}},json:真正的};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”)有效载荷=”{\“欧宝体育在线首页\”:{\“可交付\”:真的,\“_archived \”:假的,\“_draft \”:假的,\“\”:\“隐形的斗篷\”,\“ec-product-type \”,\“ff42fee0113744f693a764e3431a9cc2 \”,\“sku-properties \”:[{\“id \”,\“a37a7991f7ca1be0d349a805a2bddb5b \”,\“\”,\“颜色\”,\“enum \”:[{\“id \”,\“a9506da8e70a8b087f35a4094ec34a53 \”,\“\”,\“黑曜石黑\”,\“鼻涕虫\”:\“obsidian-black \”},{\“id \”,\“c92a465a1298c95fd1cd7f4c1c96c2ba \”,\“\”,\“烟Grey\",\"slug\":\"smoke-grey\"},{\"id\":\"ef9511c0b56cc11ff47c5669f65030b4\",\"name\":\"Forest Green\",\"slug\":\" Forest - Green\"}]}],\"description\":\"一种能使穿戴者隐形的斗篷眼睛。\”,\“鼻涕虫\ ":\ " cloak-of-invisibility-1 \”,\“更新\ ":\ " 2020 - 04 - 01 t22:40:19.329z \”,\“更新\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“上创建\ ":\ " 2020 - 04 - 01 t22:40:17.602z \”,\“由\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“发表\”:null, \“出版\”:null, \“default-sku \ ": \ " 5 e8518536e147040726cc416 \”,\“_cid \ ": \ " 5 dd44c493543b37d5449b3a5 \”,\“_id \ ": \ " 5 e8518516e147040726cc415 \ "}, \“sku \”:{\“价格\”:{\“单位\”,\“美元\”,\“价值\”:120000},\“_archived \”:假的,\“_draft \”:假的,sku-val \”问题\ \ ":{}\“宽度”:56岁的\“长度\”:0.3,\“身高\”:72年,\“体重\”:24日,\”名称\”,\“隐形斗篷的颜色:黑曜石黑色\”,\“主图片\”:{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},\“更多的图片\”:[{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},{\“文件标识\”,\“5 e85161dabd9ea4072cf1414\",\"url\":\"https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg\",\"alt\":null}],\"download-files\":[{\"id\":\"5ebb1676c3244c2c6ae18814\",\"name\":\"现代网页设计过程- Webflowurl Ebook.pdf \”,\“\”:\“https://dropbox.com/files/modern-web-design-process.pdf \ "}), \“鼻涕虫\ ":\ " cloak-of-invisibility-color-obsidian-black欧宝体育在线首页-7 \”,\“产品\ ":\ " 5 e8518516e147040726cc415 \”,\“更新\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“更新\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“上创建\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“由\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“发表\”:null, \“出版\”:null, \“_cid \ ": \ " 5 dd44c493543b37d5449b383 \”,\“_id \ ": \ " 5 e8518536e147040726cc416 \ "}}头= {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”,“内容类型”:“application / json”} conn.request (“职位”,“/网站/ 580 e63e98c9a982ac9b8b741 /欧宝体育在线首页产品”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”请求(“内容类型”] =“application / json”请求。身体=”{\“欧宝体育在线首页\”:{\“可交付\”:真的,\“_archived \”:假的,\“_draft \”:假的,\“\”:\“隐形的斗篷\”,\“ec-product-type \”,\“ff42fee0113744f693a764e3431a9cc2 \”,\“sku-properties \”:[{\“id \”,\“a37a7991f7ca1be0d349a805a2bddb5b \”,\“\”,\“颜色\”,\“enum \”:[{\“id \”,\“a9506da8e70a8b087f35a4094ec34a53 \”,\“\”,\“黑曜石黑\”,\“鼻涕虫\”:\“obsidian-black \”},{\“id \”,\“c92a465a1298c95fd1cd7f4c1c96c2ba \”,\“\”,\“烟Grey\",\"slug\":\"smoke-grey\"},{\"id\":\"ef9511c0b56cc11ff47c5669f65030b4\",\"name\":\"Forest Green\",\"slug\":\" Forest - Green\"}]}],\"description\":\"一种能使穿戴者隐形的斗篷眼睛。\”,\“鼻涕虫\ ":\ " cloak-of-invisibility-1 \”,\“更新\ ":\ " 2020 - 04 - 01 t22:40:19.329z \”,\“更新\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“上创建\ ":\ " 2020 - 04 - 01 t22:40:17.602z \”,\“由\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“发表\”:null, \“出版\”:null, \“default-sku \ ": \ " 5 e8518536e147040726cc416 \”,\“_cid \ ": \ " 5 dd44c493543b37d5449b3a5 \”,\“_id \ ": \ " 5 e8518516e147040726cc415 \ "}, \“sku \”:{\“价格\”:{\“单位\”,\“美元\”,\“价值\”:120000},\“_archived \”:假的,\“_draft \”:假的,sku-val \”问题\ \ ":{}\“宽度”:56岁的\“长度\”:0.3,\“身高\”:72年,\“体重\”:24日,\”名称\”,\“隐形斗篷的颜色:黑曜石黑色\”,\“主图片\”:{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},\“更多的图片\”:[{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},{\“文件标识\”,\“5 e85161dabd9ea4072cf1414\",\"url\":\"https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg\",\"alt\":null}],\"download-files\":[{\"id\":\"5ebb1676c3244c2c6ae18814\",\"name\":\"现代网页设计过程- Webflowurl Ebook.pdf \”,\“\”:\“https://dropbox.com/files/modern-web-design-process.pdf \ "}), \“鼻涕虫\ ":\ " cloak-of-invisibility-color-obsidian-black欧宝体育在线首页-7 \”,\“产品\ ":\ " 5 e8518516e147040726cc415 \”,\“更新\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“更新\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“上创建\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“由\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“发表\”:null, \“出版\”:null, \“_cid \ ": \ " 5 dd44c493543b37d5449b383 \”,\“_id \ ": \ " 5 e8518536e147040726cc416 \ "}}Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”“弦”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products”有效载荷:=字符串。NewReader (”{\“欧宝体育在线首页\”:{\“可交付\”:真的,\“_archived \”:假的,\“_draft \”:假的,\“\”:\“隐形的斗篷\”,\“ec-product-type \”,\“ff42fee0113744f693a764e3431a9cc2 \”,\“sku-properties \”:[{\“id \”,\“a37a7991f7ca1be0d349a805a2bddb5b \”,\“\”,\“颜色\”,\“enum \”:[{\“id \”,\“a9506da8e70a8b087f35a4094ec34a53 \”,\“\”,\“黑曜石黑\”,\“鼻涕虫\”:\“obsidian-black \”},{\“id \”,\“c92a465a1298c95fd1cd7f4c1c96c2ba \”,\“\”,\“烟Grey\",\"slug\":\"smoke-grey\"},{\"id\":\"ef9511c0b56cc11ff47c5669f65030b4\",\"name\":\"Forest Green\",\"slug\":\" Forest - Green\"}]}],\"description\":\"一种能使穿戴者隐形的斗篷眼睛。\”,\“鼻涕虫\ ":\ " cloak-of-invisibility-1 \”,\“更新\ ":\ " 2020 - 04 - 01 t22:40:19.329z \”,\“更新\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“上创建\ ":\ " 2020 - 04 - 01 t22:40:17.602z \”,\“由\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“发表\”:null, \“出版\”:null, \“default-sku \ ": \ " 5 e8518536e147040726cc416 \”,\“_cid \ ": \ " 5 dd44c493543b37d5449b3a5 \”,\“_id \ ": \ " 5 e8518516e147040726cc415 \ "}, \“sku \”:{\“价格\”:{\“单位\”,\“美元\”,\“价值\”:120000},\“_archived \”:假的,\“_draft \”:假的,sku-val \”问题\ \ ":{}\“宽度”:56岁的\“长度\”:0.3,\“身高\”:72年,\“体重\”:24日,\”名称\”,\“隐形斗篷的颜色:黑曜石黑色\”,\“主图片\”:{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},\“更多的图片\”:[{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},{\“文件标识\”,\“5 e85161dabd9ea4072cf1414\",\"url\":\"https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg\",\"alt\":null}],\"download-files\":[{\"id\":\"5ebb1676c3244c2c6ae18814\",\"name\":\"现代网页设计过程- Webflowurl Ebook.pdf \”,\“\”:\“https://dropbox.com/files/modern-web-design-process.pdf \ "}), \“鼻涕虫\ ":\ " cloak-of-invisibility-color-obsidian-black欧宝体育在线首页-7 \”,\“产品\ ":\ " 5 e8518516e147040726cc415 \”,\“更新\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“更新\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“上创建\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“由\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“发表\”:null, \“出版\”:null, \“_cid \ ": \ " 5 dd44c493543b37d5449b383 \”,\“_id \ ": \ " 5 e8518536e147040726cc416 \ "}}) req, _:= http。NewRequest (“职位”(url,有效载荷)“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”) req.Header.Add (“内容类型”,“application / json”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products”);var请求=新RestRequest (Method.POST);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);请求。AddHeader (“内容类型”,“application / json”);请求。AddParameter (“application / json”,”{\“欧宝体育在线首页\”:{\“可交付\”:真的,\“_archived \”:假的,\“_draft \”:假的,\“\”:\“隐形的斗篷\”,\“ec-product-type \”,\“ff42fee0113744f693a764e3431a9cc2 \”,\“sku-properties \”:[{\“id \”,\“a37a7991f7ca1be0d349a805a2bddb5b \”,\“\”,\“颜色\”,\“enum \”:[{\“id \”,\“a9506da8e70a8b087f35a4094ec34a53 \”,\“\”,\“黑曜石黑\”,\“鼻涕虫\”:\“obsidian-black \”},{\“id \”,\“c92a465a1298c95fd1cd7f4c1c96c2ba \”,\“\”,\“烟Grey\",\"slug\":\"smoke-grey\"},{\"id\":\"ef9511c0b56cc11ff47c5669f65030b4\",\"name\":\"Forest Green\",\"slug\":\" Forest - Green\"}]}],\"description\":\"一种能使穿戴者隐形的斗篷眼睛。\”,\“鼻涕虫\ ":\ " cloak-of-invisibility-1 \”,\“更新\ ":\ " 2020 - 04 - 01 t22:40:19.329z \”,\“更新\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“上创建\ ":\ " 2020 - 04 - 01 t22:40:17.602z \”,\“由\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“发表\”:null, \“出版\”:null, \“default-sku \ ": \ " 5 e8518536e147040726cc416 \”,\“_cid \ ": \ " 5 dd44c493543b37d5449b3a5 \”,\“_id \ ": \ " 5 e8518516e147040726cc415 \ "}, \“sku \”:{\“价格\”:{\“单位\”,\“美元\”,\“价值\”:120000},\“_archived \”:假的,\“_draft \”:假的,sku-val \”问题\ \ ":{}\“宽度”:56岁的\“长度\”:0.3,\“身高\”:72年,\“体重\”:24日,\”名称\”,\“隐形斗篷的颜色:黑曜石黑色\”,\“主图片\”:{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},\“更多的图片\”:[{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},{\“文件标识\”,\“5 e85161dabd9ea4072cf1414\",\"url\":\"https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg\",\"alt\":null}],\"download-files\":[{\"id\":\"5ebb1676c3244c2c6ae18814\",\"name\":\"现代网页设计过程- Webflowurl Ebook.pdf \”,\“\”:\“https://dropbox.com/files/modern-web-design-process.pdf \ "}), \“鼻涕虫\ ":\ " cloak-of-invisibility-color-obsidian-black欧宝体育在线首页-7 \”,\“产品\ ":\ " 5 e8518516e147040726cc415 \”,\“更新\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“更新\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“上创建\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“由\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“发表\”:null, \“出版\”:null, \“_cid \ ": \ " 5 dd44c493543b37d5449b383 \”,\“_id \ ": \ " 5 e8518536e147040726cc416 \ "}}, ParameterType.RequestBody);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
欧宝体育在线首页 |
身体 | 欧宝体育在线首页 | 假 | 的实例欧宝体育在线首页对象。 |
sku |
身体 | SKU | 假 | 的实例SKU对象。 |
响应
示例响应
{“欧宝体育在线首页产品”:{“可交付”:真正的,“_archived”:假,“_draft”:假,“名称”:“隐形斗篷”,“ec-欧宝体育在线首页product-type”:“ff42fee0113744f693a764e3431a9cc2”,“sku-properties”:[{“id”:“a37a7991f7ca1be0d349a805a2bddb5b”,“名称”:“颜色”,“枚举”:[{“id”:“a9506da8e70a8b087f35a4094ec34a53”,“名称”:“黑曜石黑”,“鼻涕虫”:“obsidian-black”},{“id”:“c92a465a1298c95fd1cd7f4c1c96c2ba”,“名称”:“烟灰色”,“鼻涕虫”:“smoke-grey”},{“id”:“ef9511c0b56cc11ff47c5669f65030b4”,“名称”:“森林绿”,“鼻涕虫”:“森林绿”}]}],“描述”:"一种能让穿着者隐形的斗篷",“鼻涕虫”:“cloak-of-invisibility-1”,“更新”:“2020 - 04 - 01 - t22:40:19.329z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 01 - t22:40:17.602z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“default-sku”:“5 e8518536e147040726cc416”,“_cid”:“5 dd44c493543b37d5449b3a5”,“_id”:“5 e8518516e147040726cc415”},“sku”:{“价格”:{“单元”:“美元”,“价值”:120000},“_archived”:假,“_draft”:假,“sku-values”:{},“宽度”:56,“长度”:0.3,“高度”:72,“重量”:24,“名称”:隐形斗篷颜色:黑曜石黑,“主图片”:{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零},“更多的图片”:[{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零},{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零}],“下载文件”:[{“id”:“5 ebb1676c3244c2c6ae18814”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“https://dropbox.com/files/modern-web-design-process.pdf”}],“鼻涕虫”:“cloak-of-invisibility-color-obsidian-black-7”,“欧宝体育在线首页产品”:“5 e8518516e147040726cc415”,“更新”:“2020 - 04 - 01 - t22:40:19.287z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 01 - t22:40:19.287z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“_cid”:“5 dd44c493543b37d5449b383”,“_id”:“5 e8518536e147040726cc416”}}
的名字 | 类型 | 描述 |
---|---|---|
欧宝体育在线首页 |
欧宝体育在线首页 | 的实例欧宝体育在线首页对象。 |
sku |
SKU | 的实例SKU对象。 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
获取产品欧宝体育在线首页和sku
根据产品的id检索单个产品。欧宝体育在线首页它的所有sku也将被检索。的数
,限制
,抵消
而且总计
响应中的值只代表Product,不包括sku。欧宝体育在线首页
请求
获得/网站/: site_id/欧宝体育在线首页产品/:欧宝体育在线首页 product_id
参数
壳牌的例子
curl -request GET \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/pr欧宝体育在线首页oducts/580e63fc8c9a982ac9b8b745 \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products/580e63fc8c9a982ac9b8b745”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“/网站/ 580 e63e98c9a982ac9b8b741 /欧宝体育在线首页产品/ 580 e63fc8c9a982ac9b8b745”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products/580e63fc8c9a982ac9b8b745”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products/580e63fc8c9a982ac9b8b745”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products/580e63fc8c9a982ac9b8b745”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
欧宝体育在线首页product_id |
路径 | 字符串 | 真正的 | 产品的唯一标识符欧宝体育在线首页 |
响应
示例响应
{“项目”:[{“欧宝体育在线首页产品”:{“可交付”:真正的,“_archived”:假,“_draft”:假,“名称”:“隐形斗篷”,“ec-欧宝体育在线首页product-type”:“ff42fee0113744f693a764e3431a9cc2”,“sku-properties”:[{“id”:“a37a7991f7ca1be0d349a805a2bddb5b”,“名称”:“颜色”,“枚举”:[{“id”:“a9506da8e70a8b087f35a4094ec34a53”,“名称”:“黑曜石黑”,“鼻涕虫”:“obsidian-black”},{“id”:“c92a465a1298c95fd1cd7f4c1c96c2ba”,“名称”:“烟灰色”,“鼻涕虫”:“smoke-grey”},{“id”:“ef9511c0b56cc11ff47c5669f65030b4”,“名称”:“森林绿”,“鼻涕虫”:“森林绿”}]}],“描述”:"一种能让穿着者隐形的斗篷",“鼻涕虫”:“cloak-of-invisibility-1”,“更新”:“2020 - 04 - 01 - t22:40:19.329z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 01 - t22:40:17.602z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“default-sku”:“5 e8518536e147040726cc416”,“_cid”:“5 dd44c493543b37d5449b3a5”,“_id”:“5 e8518516e147040726cc415”},“sku”:[{“价格”:{“单元”:“美元”,“价值”:120000},“_archived”:假,“_draft”:假,“sku-values”:{},“宽度”:56,“长度”:0.3,“高度”:72,“重量”:24,“名称”:隐形斗篷颜色:黑曜石黑,“主图片”:{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零},“更多的图片”:[{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零},{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零}],“下载文件”:[{“id”:“5 ebb1676c3244c2c6ae18814”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“https://dropbox.com/files/modern-web-design-process.pdf”}],“鼻涕虫”:“cloak-of-invisibility-color-obsidian-black-7”,“欧宝体育在线首页产品”:“5 e8518516e147040726cc415”,“更新”:“2020 - 04 - 01 - t22:40:19.287z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 01 - t22:40:19.287z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“_cid”:“5 dd44c493543b37d5449b383”,“_id”:“5 e8518536e147040726cc416”}]}],“数”:1,“限制”:One hundred.,“抵消”:0,“总”:12}
的名字 | 类型 | 描述 |
---|---|---|
项目 |
[欧宝体育在线首页] | 产品的sku列表欧宝体育在线首页 |
数 |
数量 | 退回物品数目 |
限制 |
数量 | 请求中指定的限制 |
抵消 |
数量 | 为分页指定的偏移量 |
总计 |
数量 | 集合中项目的总数 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
更新产品欧宝体育在线首页
更新现有的Product将把产品类型设置为欧宝体育在线首页先进的
.的产品类欧宝体育在线首页型用于确定向用户显示哪个product和SKU字段设计师
和编辑器
.设置它先进的
确保所有Product和SKU字段欧宝体育在线首页都将显示出来。中的产品欧宝体育在线首页类型可以编辑设计师
或者是编辑器
.
请求
补丁/网站/: site_id/欧宝体育在线首页产品/:欧宝体育在线首页 product_id
参数
壳牌的例子
curl -request PATCH \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/pr欧宝体育在线首页oducts/580e63fc8c9a982ac9b8b745 \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”\——头“application / json内容类型:\——数据{"fields": {"name": "Exciting blog post title", "slug": "Exciting -post", "_archived": false, "_draft": false, "color": "#a98080", "author": "580e640c8c9a982ac9b8b778", "post-body": " blog post content…
", "post- Summary ": "精彩博文摘要","main-image": "580e63fe8c9a982ac9b8b749"}}'
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“补丁”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products/580e63fc8c9a982ac9b8b745”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”,“内容类型”:“application / json”},身体: {字段: {的名字:“令人兴奋的博客标题”,鼻涕虫:“exciting-post”,_archived:假,_draft:假,颜色:“# a98080”,作者:580 e640c8c9a982ac9b8b778,“post”:' < p >博客内容…< / p > ',“post-summary”:“令人兴奋的博客文章摘要”,“主图片”:580 e63fe8c9a982ac9b8b749}},json:真正的};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”)有效载荷=”{\ \“字段”:{\“\”:\“激动人心的博客标题\”,\“鼻涕虫\”:\“exciting-post \”,\“_archived \”:假的,\“_draft \”:假的,\“颜色\”:\“# a98080 \”,\“\”作者:\“580 e640c8c9a982ac9b8b778 \”,\“post体\”:\“< p >博客内容…\",\"post- Summary \":\"精彩博客文章摘要\",\"main-image\":\"580e63fe8c9a982ac9b8b749\"}}"头= {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”,“内容类型”:“application / json”} conn.request (“补丁”,“/网站/ 580 e63e98c9a982ac9b8b741 /欧宝体育在线首页产品/ 580 e63fc8c9a982ac9b8b745”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products/580e63fc8c9a982ac9b8b745”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::补丁格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”请求(“内容类型”] =“application / json”请求。身体=”{\ \“字段”:{\“\”:\“激动人心的博客标题\”,\“鼻涕虫\”:\“exciting-post \”,\“_archived \”:假的,\“_draft \”:假的,\“颜色\”:\“# a98080 \”,\“\”作者:\“580 e640c8c9a982ac9b8b778 \”,\“post体\”:\“< p >博客内容…\",\"post- Summary \":\"精彩博客文章摘要\",\"main-image\":\"580e63fe8c9a982ac9b8b749\"}}"Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”“弦”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products/580e63fc8c9a982ac9b8b745”有效载荷:=字符串。NewReader (”{\ \“字段”:{\“\”:\“激动人心的博客标题\”,\“鼻涕虫\”:\“exciting-post \”,\“_archived \”:假的,\“_draft \”:假的,\“颜色\”:\“# a98080 \”,\“\”作者:\“580 e640c8c9a982ac9b8b778 \”,\“post体\”:\“< p >博客内容…\",\"post- Summary \":\"精彩博客文章摘要\",\"main-image\":\"580e63fe8c9a982ac9b8b749\"}}") req, _:= http。NewRequest (“补丁”(url,有效载荷)“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”) req.Header.Add (“内容类型”,“application / json”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products/580e63fc8c9a982ac9b8b745”);var请求=新RestRequest (Method.PATCH);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);请求。AddHeader (“内容类型”,“application / json”);请求。AddParameter (“application / json”,”{\ \“字段”:{\“\”:\“激动人心的博客标题\”,\“鼻涕虫\”:\“exciting-post \”,\“_archived \”:假的,\“_draft \”:假的,\“颜色\”:\“# a98080 \”,\“\”作者:\“580 e640c8c9a982ac9b8b778 \”,\“post体\”:\“< p >博客内容…\",\"post- Summary \":\"精彩博客文章摘要\",\"main-image\":\"580e63fe8c9a982ac9b8b749\"}}", ParameterType.RequestBody);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
欧宝体育在线首页product_id |
路径 | 字符串 | 真正的 | 产品的唯一标识符欧宝体育在线首页 |
字段 |
身体 | 场 | 假 | 的实例场对象。 |
响应
示例响应
{“可交付”:真正的,“_archived”:假,“_draft”:假,“名称”:“隐形斗篷”,“ec-欧宝体育在线首页product-type”:“ff42fee0113744f693a764e3431a9cc2”,“sku-properties”:[{“id”:“a37a7991f7ca1be0d349a805a2bddb5b”,“名称”:“颜色”,“枚举”:[{“id”:“a9506da8e70a8b087f35a4094ec34a53”,“名称”:“黑曜石黑”,“鼻涕虫”:“obsidian-black”},{“id”:“c92a465a1298c95fd1cd7f4c1c96c2ba”,“名称”:“烟灰色”,“鼻涕虫”:“smoke-grey”},{“id”:“ef9511c0b56cc11ff47c5669f65030b4”,“名称”:“森林绿”,“鼻涕虫”:“森林绿”}]}],“描述”:"一种能让穿着者隐形的斗篷",“鼻涕虫”:“cloak-of-invisibility-1”,“更新”:“2020 - 04 - 01 - t22:40:19.329z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 01 - t22:40:17.602z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“default-sku”:“5 e8518536e147040726cc416”,“_cid”:“5 dd44c493543b37d5449b3a5”,“_id”:“5 e8518516e147040726cc415”}
的名字 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 集合的唯一标识符 |
lastupdate |
字符串 | 集合最后一次更新的日期 |
createdOn |
字符串 | 创建集合的日期 |
的名字 |
字符串 | 给集合的名称 |
鼻涕虫 |
字符串 | 网站URL结构中的收集片段 |
singularName |
字符串 | 集合中某一项的名称(如集合名为“product”,则为“product”)欧宝体育在线首页 |
字段 |
[场] | 集合中的字段列表 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
创建SKU
创建额外的sku以覆盖产品的每个变体。欧宝体育在线首页默认SKU已经算作变量之一。
创建额外的sku将把产品类型设置为欧宝体育在线首页先进的
与sku相关联的欧宝体育在线首页产品。的产品类欧宝体育在线首页型用于确定向用户显示哪个product和SKU字段设计师
和编辑器
.设置它先进的
确保所有Product和SKU字段欧宝体育在线首页都将显示出来。中的产品欧宝体育在线首页类型可以编辑设计师
或者是编辑器
.
请求
POST /网站/: site_id/欧宝体育在线首页产品/:欧宝体育在线首页 product_id/ sku
参数
壳牌的例子
请求POST \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/products/580e6欧宝体育在线首页3fc8c9a982ac9b8b745/skus \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”\——头“application / json内容类型:\——数据'{"skus": [{"price": {"unit": "USD", "value": 120000}, "_archived": false, "_draft": false, "sku-values": {}, "width": 56, "length": 0.3, "height": 72, "weight": 24, "name": "隐身斗篷颜色:黑黑","main-image": {"fileId": "5e85161dabd9ea4072cf1414", "url": "https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg", "alt": null}, "more-images": [{"fileId": [{"fileId"::“5 e85161dabd9ea4072cf1414”、“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零},{"”:“5 e85161dabd9ea4072cf1414”、“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零}],“下载文件”:[{" id ":“5 ebb1676c3244c2c6ae18814”、“名称”:"现代网页设计过程- Webflow book.pdf", "url": "https://dropbox.com/files/modern-web-design-process.pdf"}], "slug": " cloakof - invisible -color-obsidian-black-7", "product": "5e8518516e1470欧宝体育在线首页40726cc415", "updated-on": "2020-04-01T22:40:19.287Z", "updated-by": "Person_5d8fcb6d94dd1853060fb3b3", "created-by": "Person_5d8fcb6d94dd1853060fb3b3", "_cid": "5dd44c493543b37d5449b383", "_id": ""5e8518536e147040726cc416"}]}'
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“职位”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products/580e63fc8c9a982ac9b8b745/skus”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”,“内容类型”:“application / json”},身体: {sku: [{价格: {单位:“美元”,价值:120000},_archived:假,_draft:假,“sku-values”: {},宽度:56,长度:0.3,高度:72,重量:24,的名字:隐形斗篷颜色:黑曜石黑,“主图片”: {文件标识:“5 e85161dabd9ea4072cf1414”,url:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,alt:零},更多的图片的: [{文件标识:“5 e85161dabd9ea4072cf1414”,url:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,alt:零}, {文件标识:“5 e85161dabd9ea4072cf1414”,url:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,alt:零}),“下载文件”: [{id:“5 ebb1676c3244c2c6ae18814”,的名字:“现代网页设计过程- Webflow电子书。pdf”,url:“https://dropbox.com/files/modern-web-design-process.pdf”}),鼻涕虫:“cloak-of-invisibility-color-obsidian-black-7”,欧宝体育在线首页:“5 e8518516e147040726cc415”,“更新”:2020 - 04 - 01 t22:40:19.287z,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:2020 - 04 - 01 t22:40:19.287z,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,_cid:“5 dd44c493543b37d5449b383”,_id:“5 e8518536e147040726cc416”}},json:真正的};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”)有效载荷=“{\“sku \”:[{\“价格\”:{\“单位\”,\“美元\”,\“价值\”:120000},\“_archived \”:假的,\“_draft \”:假的,\“sku-values \”:{},\“宽度\”:56岁\ \长度:0.3,\“身高\”:72年,\“体重\”:24日,\“\”:\“隐形斗篷的颜色:黑曜石黑色\”,\“主图片\”:{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},\“更多的图片\”:[{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},{\“文件标识\”,\“5 e85161dabd9ea4072cf1414\",\"url\":\"https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg\",\"alt\":null}],\"download-files\":[{\"id\":\"5ebb1676c3244c2c6ae18814\",\"name\":\"现代网页设计过程- Webflowurl Ebook.pdf \”,\“\”:\“https://dropbox.com/files/modern-web-design-process.pdf \ "}), \“鼻涕虫\ ":\ " cloak-of-invisibility-color-obsidian-black欧宝体育在线首页-7 \”,\“产品\ ":\ " 5 e8518516e147040726cc415 \”,\“更新\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“更新\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“上创建\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“由\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“发表\”:null, \“出版\”:null, \“_cid \ ": \ " 5 dd44c493543b37d5449b383 \”,\“_id \ ": \ " 5 e8518536e147040726cc416 \“}]}”头= {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”,“内容类型”:“application / json”} conn.request (“职位”,“/网站/ 580 e63e98c9a982ac9b8b741 /欧宝体育在线首页产品/ 580 e63fc8c9a982ac9b8b745 / sku”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products/580e63fc8c9a982ac9b8b745/skus”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”请求(“内容类型”] =“application / json”请求。身体=“{\“sku \”:[{\“价格\”:{\“单位\”,\“美元\”,\“价值\”:120000},\“_archived \”:假的,\“_draft \”:假的,\“sku-values \”:{},\“宽度\”:56岁\ \长度:0.3,\“身高\”:72年,\“体重\”:24日,\“\”:\“隐形斗篷的颜色:黑曜石黑色\”,\“主图片\”:{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},\“更多的图片\”:[{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},{\“文件标识\”,\“5 e85161dabd9ea4072cf1414\",\"url\":\"https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg\",\"alt\":null}],\"download-files\":[{\"id\":\"5ebb1676c3244c2c6ae18814\",\"name\":\"现代网页设计过程- Webflowurl Ebook.pdf \”,\“\”:\“https://dropbox.com/files/modern-web-design-process.pdf \ "}), \“鼻涕虫\ ":\ " cloak-of-invisibility-color-obsidian-black欧宝体育在线首页-7 \”,\“产品\ ":\ " 5 e8518516e147040726cc415 \”,\“更新\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“更新\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“上创建\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“由\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“发表\”:null, \“出版\”:null, \“_cid \ ": \ " 5 dd44c493543b37d5449b383 \”,\“_id \ ": \ " 5 e8518536e147040726cc416 \“}]}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”“弦”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products/580e63fc8c9a982ac9b8b745/skus”有效载荷:=字符串。NewReader (“{\“sku \”:[{\“价格\”:{\“单位\”,\“美元\”,\“价值\”:120000},\“_archived \”:假的,\“_draft \”:假的,\“sku-values \”:{},\“宽度\”:56岁\ \长度:0.3,\“身高\”:72年,\“体重\”:24日,\“\”:\“隐形斗篷的颜色:黑曜石黑色\”,\“主图片\”:{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},\“更多的图片\”:[{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},{\“文件标识\”,\“5 e85161dabd9ea4072cf1414\",\"url\":\"https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg\",\"alt\":null}],\"download-files\":[{\"id\":\"5ebb1676c3244c2c6ae18814\",\"name\":\"现代网页设计过程- Webflowurl Ebook.pdf \”,\“\”:\“https://dropbox.com/files/modern-web-design-process.pdf \ "}), \“鼻涕虫\ ":\ " cloak-of-invisibility-color-obsidian-black欧宝体育在线首页-7 \”,\“产品\ ":\ " 5 e8518516e147040726cc415 \”,\“更新\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“更新\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“上创建\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“由\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“发表\”:null, \“出版\”:null, \“_cid \ ": \ " 5 dd44c493543b37d5449b383 \”,\“_id \ ": \ " 5 e8518536e147040726cc416 \“}]}”) req, _:= http。NewRequest (“职位”(url,有效载荷)“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”) req.Header.Add (“内容类型”,“application / json”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products/580e63fc8c9a982ac9b8b745/skus”);var请求=新RestRequest (Method.POST);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);请求。AddHeader (“内容类型”,“application / json”);请求。AddParameter (“application / json”,“{\“sku \”:[{\“价格\”:{\“单位\”,\“美元\”,\“价值\”:120000},\“_archived \”:假的,\“_draft \”:假的,\“sku-values \”:{},\“宽度\”:56岁\ \长度:0.3,\“身高\”:72年,\“体重\”:24日,\“\”:\“隐形斗篷的颜色:黑曜石黑色\”,\“主图片\”:{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},\“更多的图片\”:[{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},{\“文件标识\”,\“5 e85161dabd9ea4072cf1414\",\"url\":\"https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg\",\"alt\":null}],\"download-files\":[{\"id\":\"5ebb1676c3244c2c6ae18814\",\"name\":\"现代网页设计过程- Webflowurl Ebook.pdf \”,\“\”:\“https://dropbox.com/files/modern-web-design-process.pdf \ "}), \“鼻涕虫\ ":\ " cloak-of-invisibility-color-obsidian-black欧宝体育在线首页-7 \”,\“产品\ ":\ " 5 e8518516e147040726cc415 \”,\“更新\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“更新\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“上创建\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“由\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“发表\”:null, \“出版\”:null, \“_cid \ ": \ " 5 dd44c493543b37d5449b383 \”,\“_id \ ": \ " 5 e8518536e147040726cc416 \“}]}”, ParameterType.RequestBody);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
欧宝体育在线首页product_id |
路径 | 字符串 | 真正的 | 产品的唯一标识符欧宝体育在线首页 |
sku |
身体 | [SKU] | 假 | 要添加的SKU数据的数组 |
响应
示例响应
{“sku”:[{“鼻涕虫”:“cloak-of-invisibility-color-smoke-grey”,“_archived”:假,“_draft”:假,“价格”:{“单元”:“美元”,“价值”:120000},“更多的图片”:[],“下载文件”:[{“id”:“5 ebb1945c3244c2c6ae18822”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“https://dropbox.com/files/modern-web-design-process.pdf”}],“sku-values”:{“a37a7991f7ca1be0d349a805a2bddb5b”:“c92a465a1298c95fd1cd7f4c1c96c2ba”},“宽度”:56,“长度”:0.3,“高度”:72,“重量”:24,“名称”:隐形斗篷颜色:烟灰色,“主图片”:{“文件标识”:“5 e8512181ae993035b15f315”,“文件”:{“_id”:“5 e8512181ae993035b15f315”,“变异”:[{“_id”:“5 e85121b1ae993035b15f316”,“origFileName”:“外部——content.duckduckgo.com——p - 500. - jpeg ",“文件名”:“5 e8512181ae993035b15f315_external——content.duckduckgo.com——p - 500. - jpeg ",“格式”:“jpeg”,“大小”:54068,“宽度”:500,“质量”:One hundred.,“s3Url”:“https://s3.amazonaws.com/webflow - dev - assets/5e8402eb8a402e354bd469bb/5e8512181ae993035b15f315_external content.duckduckgo.com——p - 500. - jpeg "}],“origFileName”:“invisibility_cloak.jpg”,“文件名”:“5 e8512181ae993035b15f315_external-content.duckduckgo.com.jpg”,“fileHash”:“860 b1b99ce90aa6c175bfcd9fd59fd42”,“s3Url”:“https://s3.amazonaws.com/webflow-dev-assets/5e8402eb8a402e354bd469bb/5e8512181ae993035b15f315_external-content.duckduckgo.com.jpg”,“mimeType”:“图像/ jpeg”,“大小”:192263,“宽度”:550,“高度”:550,“数据库”:“5 e8402eb8a402e354bd469bb”,“createdOn”:“2020 - 04 - 01 - t22:13:44.889z”,“__v”:1,“updatedOn”:“2020 - 04 - 01 - t22:13:59.777z”},“文件大小”:192263,“url”:“https://d1otoma47x30pg.cloudfront.net/5e8402eb8a402e354bd469bb/5e8512181ae993035b15f315_external-content.duckduckgo.com.jpg”,“alt”:零},“欧宝体育在线首页产品”:“5 e8518516e147040726cc415”,“更新”:“2020 - 04 - 03 - t18:50:45.947z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 03 - t18:50:45.947z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“_cid”:“5 e8402eb8a402e354bd469be”,“_id”:“5 e8785855617d73f34627a93”},{“_archived”:假,“_draft”:假,“价格”:{“单元”:“美元”,“价值”:120000},“更多的图片”:[],“下载文件”:[{“id”:“5 ebb1945c3244c2c6ae18823”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“https://dropbox.com/files/modern-web-design-process.pdf”}],“sku-values”:{“a37a7991f7ca1be0d349a805a2bddb5b”:“ef9511c0b56cc11ff47c5669f65030b4”},“宽度”:56,“长度”:0.3,“高度”:72,“重量”:24,“名称”:隐形斗篷颜色:森林绿,“主图片”:{“文件标识”:“5 e8512181ae993035b15f315”,“文件”:{“_id”:“5 e8512181ae993035b15f315”,“变异”:[{“_id”:“5 e85121b1ae993035b15f316”,“origFileName”:“外部——content.duckduckgo.com——p - 500. - jpeg ",“文件名”:“5 e8512181ae993035b15f315_external——content.duckduckgo.com——p - 500. - jpeg ",“格式”:“jpeg”,“大小”:54068,“宽度”:500,“质量”:One hundred.,“s3Url”:“https://s3.amazonaws.com/webflow - dev - assets/5e8402eb8a402e354bd469bb/5e8512181ae993035b15f315_external content.duckduckgo.com——p - 500. - jpeg "}],“origFileName”:“invisibility_cloak.jpg”,“文件名”:“5 e8512181ae993035b15f315_external-content.duckduckgo.com.jpg”,“fileHash”:“860 b1b99ce90aa6c175bfcd9fd59fd42”,“s3Url”:“https://s3.amazonaws.com/webflow-dev-assets/5e8402eb8a402e354bd469bb/5e8512181ae993035b15f315_external-content.duckduckgo.com.jpg”,“mimeType”:“图像/ jpeg”,“大小”:192263,“宽度”:550,“高度”:550,“数据库”:“5 e8402eb8a402e354bd469bb”,“createdOn”:“2020 - 04 - 01 - t22:13:44.889z”,“__v”:1,“updatedOn”:“2020 - 04 - 01 - t22:13:59.777z”},“文件大小”:192263,“url”:“https://d1otoma47x30pg.cloudfront.net/5e8402eb8a402e354bd469bb/5e8512181ae993035b15f315_external-content.duckduckgo.com.jpg”,“alt”:零},“鼻涕虫”:“cloak-of-invisibility-color-forest-green”,“欧宝体育在线首页产品”:“5 e8518516e147040726cc415”,“更新”:“2020 - 04 - 03 - t18:50:45.949z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 03 - t18:50:45.949z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“_cid”:“5 e8402eb8a402e354bd469be”,“_id”:“5 e8785855617d73f34627a94”}]}
的名字 | 类型 | 描述 |
---|---|---|
sku |
[SKU] |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
更新SKU
更新现有的SKU将把产品类型设置为欧宝体育在线首页先进的
与SKU相关联的欧宝体育在线首页产品。的产品类欧宝体育在线首页型用于确定向用户显示哪个product和SKU字段设计师
和编辑器
.设置它先进的
确保所有Product和SKU字段欧宝体育在线首页都将显示出来。中的产品欧宝体育在线首页类型可以编辑设计师
或者是编辑器
.
请求
补丁/网站/: site_id/欧宝体育在线首页产品/:欧宝体育在线首页 product_id/ sku /: sku_id
参数
壳牌的例子
curl -request PATCH \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/pr欧宝体育在线首页oducts/580e63fc8c9a982ac9b8b745/skus/5e8518516e147040726cc415 \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”\——头“application / json内容类型:\——数据'{"sku": {"price": {"unit": "USD", "value": 120000}, "_archived": false, "_draft": false, "sku-values": {}, "width": 56, "length": 0.3, "height": 72, "weight": 24, "name": "隐身斗篷颜色:黑黑","main-image": {"fileId": "5e85161dabd9ea4072cf1414", "url": "https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg", "alt": null}, "more-images": [{"fileId"::“5 e85161dabd9ea4072cf1414”、“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零},{"”:“5 e85161dabd9ea4072cf1414”、“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零}],“下载文件”:[{" id ":“5 ebb1676c3244c2c6ae18814”、“名称”:"现代网页设计过程- Webflow book.pdf", "url": "https://dropbox.com/files/modern-web-design-process.pdf"}], "slug": " cloakof - invisible -color-obsidian-black-7", "product": "5e8518516e1470欧宝体育在线首页40726cc415", "updated-on": "2020-04-01T22:40:19.287Z", "updated-by": "Person_5d8fcb6d94dd1853060fb3b3", "created-by": "Person_5d8fcb6d94dd1853060fb3b3", "_cid": "5dd44c493543b37d5449b383", "_id": "“5 e8518536e147040726cc416“}}
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“补丁”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products/580e63fc8c9a982ac9b8b745/skus/5e8518516e147040726cc415”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”,“内容类型”:“application / json”},身体: {sku: {价格: {单位:“美元”,价值:120000},_archived:假,_draft:假,“sku-values”: {},宽度:56,长度:0.3,高度:72,重量:24,的名字:隐形斗篷颜色:黑曜石黑,“主图片”: {文件标识:“5 e85161dabd9ea4072cf1414”,url:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,alt:零},更多的图片的: [{文件标识:“5 e85161dabd9ea4072cf1414”,url:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,alt:零}, {文件标识:“5 e85161dabd9ea4072cf1414”,url:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,alt:零}),“下载文件”: [{id:“5 ebb1676c3244c2c6ae18814”,的名字:“现代网页设计过程- Webflow电子书。pdf”,url:“https://dropbox.com/files/modern-web-design-process.pdf”}),鼻涕虫:“cloak-of-invisibility-color-obsidian-black-7”,欧宝体育在线首页:“5 e8518516e147040726cc415”,“更新”:2020 - 04 - 01 t22:40:19.287z,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:2020 - 04 - 01 t22:40:19.287z,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,_cid:“5 dd44c493543b37d5449b383”,_id:“5 e8518536e147040726cc416”}},json:真正的};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”)有效载荷=”{\“sku \”:{\“价格\”:{\“单位\”,\“美元\”,\“价值\”:120000},\“_archived \”:假的,\“_draft \”:假的,\“sku-values \”:{},\“宽度\”:56岁\ \长度:0.3,\“身高\”:72年,\“体重\”:24日,\“\”:\“隐形斗篷的颜色:黑曜石黑色\”,\“主图片\”:{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},\“更多的图片\”:[{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},{\“文件标识\”,\“5 e85161dabd9ea4072cf1414\",\"url\":\"https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg\",\"alt\":null}],\"download-files\":[{\"id\":\"5ebb1676c3244c2c6ae18814\",\"name\":\"现代网页设计过程- Webflowurl Ebook.pdf \”,\“\”:\“https://dropbox.com/files/modern-web-design-process.pdf \ "}), \“鼻涕虫\ ":\ " cloak-of-invisibility-color-obsidian-black欧宝体育在线首页-7 \”,\“产品\ ":\ " 5 e8518516e147040726cc415 \”,\“更新\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“更新\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“上创建\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“由\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“发表\”:null, \“出版\”:null, \“_cid \ ": \ " 5 dd44c493543b37d5449b383 \”,\“_id \ ": \ " 5 e8518536e147040726cc416 \ "}}头= {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”,“内容类型”:“application / json”} conn.request (“补丁”,“/网站/ 580 e63e98c9a982ac9b8b741 /欧宝体育在线首页产品/ 580 e63fc8c9a982ac9b8b745 / sku / 5 e8518516e147040726cc415”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products/580e63fc8c9a982ac9b8b745/skus/5e8518516e147040726cc415”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::补丁格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”请求(“内容类型”] =“application / json”请求。身体=”{\“sku \”:{\“价格\”:{\“单位\”,\“美元\”,\“价值\”:120000},\“_archived \”:假的,\“_draft \”:假的,\“sku-values \”:{},\“宽度\”:56岁\ \长度:0.3,\“身高\”:72年,\“体重\”:24日,\“\”:\“隐形斗篷的颜色:黑曜石黑色\”,\“主图片\”:{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},\“更多的图片\”:[{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},{\“文件标识\”,\“5 e85161dabd9ea4072cf1414\",\"url\":\"https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg\",\"alt\":null}],\"download-files\":[{\"id\":\"5ebb1676c3244c2c6ae18814\",\"name\":\"现代网页设计过程- Webflowurl Ebook.pdf \”,\“\”:\“https://dropbox.com/files/modern-web-design-process.pdf \ "}), \“鼻涕虫\ ":\ " cloak-of-invisibility-color-obsidian-black欧宝体育在线首页-7 \”,\“产品\ ":\ " 5 e8518516e147040726cc415 \”,\“更新\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“更新\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“上创建\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“由\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“发表\”:null, \“出版\”:null, \“_cid \ ": \ " 5 dd44c493543b37d5449b383 \”,\“_id \ ": \ " 5 e8518536e147040726cc416 \ "}}Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”“弦”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products/580e63fc8c9a982ac9b8b745/skus/5e8518516e147040726cc415”有效载荷:=字符串。NewReader (”{\“sku \”:{\“价格\”:{\“单位\”,\“美元\”,\“价值\”:120000},\“_archived \”:假的,\“_draft \”:假的,\“sku-values \”:{},\“宽度\”:56岁\ \长度:0.3,\“身高\”:72年,\“体重\”:24日,\“\”:\“隐形斗篷的颜色:黑曜石黑色\”,\“主图片\”:{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},\“更多的图片\”:[{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},{\“文件标识\”,\“5 e85161dabd9ea4072cf1414\",\"url\":\"https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg\",\"alt\":null}],\"download-files\":[{\"id\":\"5ebb1676c3244c2c6ae18814\",\"name\":\"现代网页设计过程- Webflowurl Ebook.pdf \”,\“\”:\“https://dropbox.com/files/modern-web-design-process.pdf \ "}), \“鼻涕虫\ ":\ " cloak-of-invisibility-color-obsidian-black欧宝体育在线首页-7 \”,\“产品\ ":\ " 5 e8518516e147040726cc415 \”,\“更新\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“更新\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“上创建\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“由\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“发表\”:null, \“出版\”:null, \“_cid \ ": \ " 5 dd44c493543b37d5449b383 \”,\“_id \ ": \ " 5 e8518536e147040726cc416 \ "}}) req, _:= http。NewRequest (“补丁”(url,有效载荷)“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”) req.Header.Add (“内容类型”,“application / json”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/欧宝体育在线首页products/580e63fc8c9a982ac9b8b745/skus/5e8518516e147040726cc415”);var请求=新RestRequest (Method.PATCH);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);请求。AddHeader (“内容类型”,“application / json”);请求。AddParameter (“application / json”,”{\“sku \”:{\“价格\”:{\“单位\”,\“美元\”,\“价值\”:120000},\“_archived \”:假的,\“_draft \”:假的,\“sku-values \”:{},\“宽度\”:56岁\ \长度:0.3,\“身高\”:72年,\“体重\”:24日,\“\”:\“隐形斗篷的颜色:黑曜石黑色\”,\“主图片\”:{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},\“更多的图片\”:[{\“文件标识\”,\“5 e85161dabd9ea4072cf1414 \”,\“url \”:\“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg \”,\“alt \”:零},{\“文件标识\”,\“5 e85161dabd9ea4072cf1414\",\"url\":\"https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg\",\"alt\":null}],\"download-files\":[{\"id\":\"5ebb1676c3244c2c6ae18814\",\"name\":\"现代网页设计过程- Webflowurl Ebook.pdf \”,\“\”:\“https://dropbox.com/files/modern-web-design-process.pdf \ "}), \“鼻涕虫\ ":\ " cloak-of-invisibility-color-obsidian-black欧宝体育在线首页-7 \”,\“产品\ ":\ " 5 e8518516e147040726cc415 \”,\“更新\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“更新\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“上创建\ ":\ " 2020 - 04 - 01 t22:40:19.287z \”,\“由\ ":\ " Person_5d8fcb6d94dd1853060fb3b3 \”,\“发表\”:null, \“出版\”:null, \“_cid \ ": \ " 5 dd44c493543b37d5449b383 \”,\“_id \ ": \ " 5 e8518536e147040726cc416 \ "}}, ParameterType.RequestBody);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
欧宝体育在线首页product_id |
路径 | 字符串 | 真正的 | 产品的唯一标识符欧宝体育在线首页 |
sku_id |
路径 | 字符串 | 真正的 | SKU的唯一标识符 |
sku |
身体 | SKU | 假 | 的实例SKU对象。 |
响应
示例响应
{“价格”:{“单元”:“美元”,“价值”:120000},“_archived”:假,“_draft”:假,“sku-values”:{},“宽度”:56,“长度”:0.3,“高度”:72,“重量”:24,“名称”:隐形斗篷颜色:黑曜石黑,“主图片”:{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零},“更多的图片”:[{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零},{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零}],“下载文件”:[{“id”:“5 ebb1676c3244c2c6ae18814”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“https://dropbox.com/files/modern-web-design-process.pdf”}],“鼻涕虫”:“cloak-of-invisibility-color-obsidian-black-7”,“欧宝体育在线首页产品”:“5 e8518516e147040726cc415”,“更新”:“2020 - 04 - 01 - t22:40:19.287z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 01 - t22:40:19.287z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“_cid”:“5 dd44c493543b37d5449b383”,“_id”:“5 e8518536e147040726cc416”}
的名字 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 集合的唯一标识符 |
lastupdate |
字符串 | 集合最后一次更新的日期 |
createdOn |
字符串 | 创建集合的日期 |
的名字 |
字符串 | 给集合的名称 |
鼻涕虫 |
字符串 | 网站URL结构中的收集片段 |
singularName |
字符串 | 集合中某一项的名称(如集合名为“sku”,则为“sku”) |
字段 |
[场] | 集合中的字段列表 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
订单
订单列表
列出为给定网站创建的所有订单。
请求
获得/网站/: site_id/订单
参数
壳牌的例子
curl——请求GET \——url“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/orders?status=SOME_STRING_VALUE&offset=0&limit=100”\——头“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/orders”,qs: {状态:“SOME_STRING_VALUE”,抵消:' 0 ',限制:“100”},头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“/网站/ 580 e63e98c9a982ac9b8b741 /订单吗?状态=SOME_STRING_VALUE&offset=0&limit=100"res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/orders?status=SOME_STRING_VALUE&offset=0&limit=100”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/orders?status=SOME_STRING_VALUE&offset=0&limit=100”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/orders?status=SOME_STRING_VALUE&offset=0&limit=100”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
状态 |
查询 | 字符串 | 假 | 按状态筛选订单 |
抵消 |
查询 | 数量 | 假 | 如果结果有超过限制的记录,则用于分页的偏移量 |
限制 |
查询 | 数量 | 假 | 返回的最大记录数(最大限制:100) |
响应
示例响应
[{“orderId”:“dfa-3f1”,“状态”:“未实现”,“评论”:"",“orderComment”:"",“acceptedOn”:“2018 - 12 - 03 - t22:06:15.761z”,“disputedOn”:零,“disputeUpdatedOn”:零,“disputeLastStatus”:零,“fulfilledOn”:零,“refundedOn”:零,“customerPaid”:{“单元”:“美元”,“价值”:6099,“字符串”:“60.99”},“netAmount”:{“单元”:“美元”,“价值”:5892,“字符串”:“58.92”},“requiresShipping”:真正的,“shippingProvider”:零,“shippingTracking”:零,“customerInfo”:{“fullName”:“Customerio以”,“电子邮件”:“任+ customer@www.raktarban.com”},“allAddresses”:[{“类型”:“账单”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},{“类型”:“运输”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”}],“shippingAddress”:{“类型”:“运输”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},“billingAddress”:{“类型”:“账单”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},“purchasedItems”:[{“数”:1,“rowTotal”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“欧宝体育在线首页productId”:“5 eb9fd05caef491eb9757183”,“欧宝体育在线首页productName”:“白杯”,“欧宝体育在线首页productSlug”:“白色杯子”,“variantId”:“5 eb9fcace279761d8199790c”,“variantName”:“white-cup_default_sku”,“variantSlug”:“white-cup-default-sku”,“variantImage”:{“文件标识”:“5 bfedb42bab0ad90fa7dad2e”,“url”:“https://d1otoma47x30pg.cloudfront.net/5bfedb42bab0ad90fa7dac03/5bfedb42bab0ad90fa7dad2e_5bb3d019b3465c6e8a324dd7_458036-unsplas.png”},“variantPrice”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“高度”:7,“长度”:2,“重量”:5,“宽度”:4}],“purchasedItemsCount”:1,“stripeDetails”:{“refundReason”:零,“refundId”:零,“disputeId”:零,“chargeId”:“ch_1DdPYQKMjGA7k9mI2AKiBY6u”,“customerId”:“cus_E5ajeiWNHEtcAW”},“stripeCard”:{“last4”:“4242”,“品牌”:“签证”,“ownerName”:“Customerio以”,“过期”:{“年”:2023,“月”:12}},“总数”:{“小计”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“临时演员”:[{“类型”:“税”,“名称”:“国家税收”,“描述”:”“CA税(6.25%),“价格”:{“单元”:“美元”,“价值”:344,“字符串”:“3.44”}},{“类型”:“税”,“名称”:“县税”,“描述”:洛杉矶税(1.00%),“价格”:{“单元”:“美元”,“价值”:55,“字符串”:“0.55”}},{“类型”:“税”,“名称”:“特别区税”,“描述”:特别地区税(2.25%),“价格”:{“单元”:“美元”,“价值”:124,“字符串”:“1.24”}},{“类型”:“运输”,“名称”:“平率”,“描述”:"",“价格”:{“单元”:“美元”,“价值”:599,“字符串”:“5.99”}},{“类型”:“discount-shipping”,“名称”:“免费送货(SHIP4FREE)”,“描述”:"",“价格”:{“单元”:“美元”,“价值”:-599年,“字符串”:”——5.99美元”}}],“总”:{“单元”:“美元”,“价值”:6023,“字符串”:“60.23”}},“customData”:[{“textInput”:“(415)123 - 4567”,“名称”:“电话”},{“文本区域”:“妈妈生日快乐!”,“名称”:“礼物注意”},{“复选框”:真正的,“名称”:“送礼物”}],“downloadFiles”:[{“id”:“5 e9a5eba75e0ac242e1b6f64”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“//www.raktarban.com/dashboard/download-digital-欧宝体育在线首页product?payload=5d93ba5e38c6b0160ab711d3; e7634a; 5 eb1aac72912ec06f561278c; 5 e9a5eba75e0ac242e1b6f63: ka2nehxy: 4 a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa”},{“id”:“5 e9a5eba75e0ac242e1b6f63”,“名称”:自由网页设计师指南- Webflow电子书。pdf,“url”:“//www.raktarban.com/dashboard/download-digital-欧宝体育在线首页product?payload=5d93ba5e38c6b0160ab711d3; e7634a; 5 dd44c493543b37d5449b3cd; 5 e9a5eba75e0ac242e1b6f63: ka2nehxy: 6 af5adf7c6fff7a3b0f54404fac1be492ac6f1ed5340416f1fe27c5fd4dd8079”}]}]
的名字 | 类型 | 描述 |
---|---|---|
orderId |
字符串 | 订单id。通常是6个十六进制字符,但如果网站有大量的订单,也可以是9个十六进制字符。随机分配。 |
状态 |
字符串 | 之一等待 ,未实现的 ,实现了 ,有争议的 ,dispute-lost ,或退还 |
评论 |
字符串 | 此订单的注释字符串,可由API用户编辑(Webflow不使用)。 |
orderComment |
字符串 | 顾客在下单时留下的注释 |
acceptedOn |
字符串 | 下单的ISO8601时间戳。 |
disputedOn |
字符串 | 如果客户对订单有争议,那么该密钥将设置为ISO8601时间戳,Stripe将通知Webflow。如果没有争议,则为空。 |
disputeUpdatedOn |
字符串 | 如果客户对订单有争议,那么这个密钥将使用我们最后一次获得更新的ISO8601时间戳设置。如果没有争议,则为空。 |
disputeLastStatus |
字符串 | 如果客户对订单有异议,则将设置此键 |
与争议的地位. | ||
fulfilledOn |
字符串 | 如果订单被标记为“已完成”,那么这是发生时的ISO8601时间戳。 |
refundedOn |
字符串 | 如果订单被退款,这是发生时间的ISO8601。 |
customerPaid |
OrderAmount | 的实例OrderAmount对象。 |
netAmount |
OrderAmount | 的实例OrderAmount对象。 |
requiresShipping |
布尔 | 一个布尔值,指示订单是否包含一个或多个需要运输的已购买项目。 |
shippingProvider |
字符串 | API用户可编辑的字符串,以说明使用的运输提供程序(Webflow不使用)。 |
shippingTracking |
字符串 | API用户可编辑的字符串,用于记录订单的发货跟踪编号(Webflow不使用)。 |
customerInfo |
OrderCustomerInfo | 的实例OrderCustomerInfo对象。 |
allAddresses |
[OrderAddress] | 客户在订购流程中提供的所有地址。 |
shippingAddress |
OrderAddress | 的实例OrderAddress对象。 |
billingAddress |
OrderAddress | 的实例OrderAddress对象。 |
purchasedItems |
[OrderPurchasedItem] | 顾客购买的所有东西的数组。 |
stripeDetails |
StripeDetails | 的实例StripeDetails对象。 |
stripeCard |
StripeCard | 的实例StripeCard对象。 |
总数 |
OrderTotals | 的实例OrderTotals对象。 |
customData |
(对象) | 用于自定义订单数据收集的附加输入数组。数组中的每个对象都表示一个具有名称和texttinput、textArea或复选框值的输入。 |
downloadFiles |
[OrderDownloadedFile] | 可下载文件对象的数组。 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
得到订单
根据产品的id检索单个产品。欧宝体育在线首页它的所有sku也将被检索。的数
,限制
,抵消
而且总计
响应中的值只代表Product,不包括sku。欧宝体育在线首页
请求
获得/网站/: site_id/订单/: order_id
参数
壳牌的例子
curl -request GET \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415 \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“/网站/ 580 e63e98c9a982ac9b8b741 /订单/ 5 e8518516e147040726cc415”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
order_id |
路径 | 字符串 | 真正的 | 订单的唯一标识符 |
响应
示例响应
{“orderId”:“dfa-3f1”,“状态”:“未实现”,“评论”:"",“orderComment”:"",“acceptedOn”:“2018 - 12 - 03 - t22:06:15.761z”,“disputedOn”:零,“disputeUpdatedOn”:零,“disputeLastStatus”:零,“fulfilledOn”:零,“refundedOn”:零,“customerPaid”:{“单元”:“美元”,“价值”:6099,“字符串”:“60.99”},“netAmount”:{“单元”:“美元”,“价值”:5892,“字符串”:“58.92”},“requiresShipping”:真正的,“shippingProvider”:零,“shippingTracking”:零,“customerInfo”:{“fullName”:“Customerio以”,“电子邮件”:“任+ customer@www.raktarban.com”},“allAddresses”:[{“类型”:“账单”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},{“类型”:“运输”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”}],“shippingAddress”:{“类型”:“运输”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},“billingAddress”:{“类型”:“账单”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},“purchasedItems”:[{“数”:1,“rowTotal”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“欧宝体育在线首页productId”:“5 eb9fd05caef491eb9757183”,“欧宝体育在线首页productName”:“白杯”,“欧宝体育在线首页productSlug”:“白色杯子”,“variantId”:“5 eb9fcace279761d8199790c”,“variantName”:“white-cup_default_sku”,“variantSlug”:“white-cup-default-sku”,“variantImage”:{“文件标识”:“5 bfedb42bab0ad90fa7dad2e”,“url”:“https://d1otoma47x30pg.cloudfront.net/5bfedb42bab0ad90fa7dac03/5bfedb42bab0ad90fa7dad2e_5bb3d019b3465c6e8a324dd7_458036-unsplas.png”},“variantPrice”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“高度”:7,“长度”:2,“重量”:5,“宽度”:4}],“purchasedItemsCount”:1,“stripeDetails”:{“refundReason”:零,“refundId”:零,“disputeId”:零,“chargeId”:“ch_1DdPYQKMjGA7k9mI2AKiBY6u”,“customerId”:“cus_E5ajeiWNHEtcAW”},“stripeCard”:{“last4”:“4242”,“品牌”:“签证”,“ownerName”:“Customerio以”,“过期”:{“年”:2023,“月”:12}},“总数”:{“小计”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“临时演员”:[{“类型”:“税”,“名称”:“国家税收”,“描述”:”“CA税(6.25%),“价格”:{“单元”:“美元”,“价值”:344,“字符串”:“3.44”}},{“类型”:“税”,“名称”:“县税”,“描述”:洛杉矶税(1.00%),“价格”:{“单元”:“美元”,“价值”:55,“字符串”:“0.55”}},{“类型”:“税”,“名称”:“特别区税”,“描述”:特别地区税(2.25%),“价格”:{“单元”:“美元”,“价值”:124,“字符串”:“1.24”}},{“类型”:“运输”,“名称”:“平率”,“描述”:"",“价格”:{“单元”:“美元”,“价值”:599,“字符串”:“5.99”}},{“类型”:“折扣”,“名称”:“折扣(SAVE5)”,“描述”:"",“价格”:{“单元”:“美元”,“价值”:-500年,“字符串”:”——5.00美元”}}],“总”:{“单元”:“美元”,“价值”:6122,“字符串”:“61.22”}},“customData”:[{“textInput”:“(415)123 - 4567”,“名称”:“电话”},{“文本区域”:“妈妈生日快乐!”,“名称”:“礼物注意”},{“复选框”:真正的,“名称”:“送礼物”}],“downloadFiles”:[{“id”:“5 e9a5eba75e0ac242e1b6f64”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“//www.raktarban.com/dashboard/download-digital-欧宝体育在线首页product?payload=5d93ba5e38c6b0160ab711d3; e7634a; 5 eb1aac72912ec06f561278c; 5 e9a5eba75e0ac242e1b6f63: ka2nehxy: 4 a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa”},{“id”:“5 e9a5eba75e0ac242e1b6f63”,“名称”:自由网页设计师指南- Webflow电子书。pdf,“url”:“//www.raktarban.com/dashboard/download-digital-欧宝体育在线首页product?payload=5d93ba5e38c6b0160ab711d3; e7634a; 5 dd44c493543b37d5449b3cd; 5 e9a5eba75e0ac242e1b6f63: ka2nehxy: 6 af5adf7c6fff7a3b0f54404fac1be492ac6f1ed5340416f1fe27c5fd4dd8079”}]}
的名字 | 类型 | 描述 |
---|---|---|
orderId |
字符串 | 订单id。通常是6个十六进制字符,但如果网站有大量的订单,也可以是9个十六进制字符。随机分配。 |
状态 |
字符串 | 之一等待 ,未实现的 ,实现了 ,有争议的 ,dispute-lost ,或退还 |
评论 |
字符串 | 此订单的注释字符串,可由API用户编辑(Webflow不使用)。 |
orderComment |
字符串 | 顾客在下单时留下的注释 |
acceptedOn |
字符串 | 下单的ISO8601时间戳。 |
disputedOn |
字符串 | 如果客户对订单有争议,那么该密钥将设置为ISO8601时间戳,Stripe将通知Webflow。如果没有争议,则为空。 |
disputeUpdatedOn |
字符串 | 如果客户对订单有争议,那么这个密钥将使用我们最后一次获得更新的ISO8601时间戳设置。如果没有争议,则为空。 |
disputeLastStatus |
字符串 | 如果客户对订单有异议,则将设置此键 |
与争议的地位. | ||
fulfilledOn |
字符串 | 如果订单被标记为“已完成”,那么这是发生时的ISO8601时间戳。 |
refundedOn |
字符串 | 如果订单被退款,这是发生时间的ISO8601。 |
customerPaid |
OrderAmount | 的实例OrderAmount对象。 |
netAmount |
OrderAmount | 的实例OrderAmount对象。 |
requiresShipping |
布尔 | 一个布尔值,指示订单是否包含一个或多个需要运输的已购买项目。 |
shippingProvider |
字符串 | API用户可编辑的字符串,以说明使用的运输提供程序(Webflow不使用)。 |
shippingTracking |
字符串 | API用户可编辑的字符串,用于记录订单的发货跟踪编号(Webflow不使用)。 |
customerInfo |
OrderCustomerInfo | 的实例OrderCustomerInfo对象。 |
allAddresses |
[OrderAddress] | 客户在订购流程中提供的所有地址。 |
shippingAddress |
OrderAddress | 的实例OrderAddress对象。 |
billingAddress |
OrderAddress | 的实例OrderAddress对象。 |
purchasedItems |
[OrderPurchasedItem] | 顾客购买的所有东西的数组。 |
stripeDetails |
StripeDetails | 的实例StripeDetails对象。 |
stripeCard |
StripeCard | 的实例StripeCard对象。 |
总数 |
OrderTotals | 的实例OrderTotals对象。 |
customData |
(对象) | 用于自定义订单数据收集的附加输入数组。数组中的每个对象都表示一个具有名称和texttinput、textArea或复选框值的输入。 |
downloadFiles |
[OrderDownloadedFile] | 可下载文件对象的数组。 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
更新订单
这个API允许你更新字段,评论
,shippingProvider
和/或shippingTracking
对于一个给定的顺序。这三个字段可以同时更新,也可以独立更新。
请求
补丁/网站/: site_id/订单/: order_id
参数
壳牌的例子
curl -request PATCH \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415 \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”\——头“application / json内容类型:\——数据“{"fields": {"comment": "给自己的示例评论","shippingProvider": "Shipping Company, Co.", "shippingTracking": "tr00000000001"}}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“补丁”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”,“内容类型”:“application / json”},身体: {字段: {评论:“给自己的示例注释”,shippingProvider:航运公司,有限公司,shippingTracking:“tr00000000001”}},json:真正的};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”)有效载荷="{\"fields\":{\"comment\":\"对myself的注释示例\",\"shippingProvider\":\"Shipping Company, Co.\",\"shippingTracking\":\"tr00000000001\"}}"头= {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”,“内容类型”:“application / json”} conn.request (“补丁”,“/网站/ 580 e63e98c9a982ac9b8b741 /订单/ 5 e8518516e147040726cc415”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::补丁格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”请求(“内容类型”] =“application / json”请求。身体="{\"fields\":{\"comment\":\"对myself的注释示例\",\"shippingProvider\":\"Shipping Company, Co.\",\"shippingTracking\":\"tr00000000001\"}}"Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”“弦”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415”有效载荷:=字符串。NewReader ("{\"fields\":{\"comment\":\"对myself的注释示例\",\"shippingProvider\":\"Shipping Company, Co.\",\"shippingTracking\":\"tr00000000001\"}}") req, _:= http。NewRequest (“补丁”(url,有效载荷)“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”) req.Header.Add (“内容类型”,“application / json”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415”);var请求=新RestRequest (Method.PATCH);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);请求。AddHeader (“内容类型”,“application / json”);请求。AddParameter (“application / json”,"{\"fields\":{\"comment\":\"对myself的注释示例\",\"shippingProvider\":\"Shipping Company, Co.\",\"shippingTracking\":\"tr00000000001\"}}", ParameterType.RequestBody);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
order_id |
路径 | 字符串 | 真正的 | 订单的唯一标识符 |
字段 |
身体 | 对象 | 假 |
响应
示例响应
{“orderId”:“dfa-3f1”,“状态”:“未实现”,“评论”:"",“orderComment”:"",“acceptedOn”:“2018 - 12 - 03 - t22:06:15.761z”,“disputedOn”:零,“disputeUpdatedOn”:零,“disputeLastStatus”:零,“fulfilledOn”:零,“refundedOn”:零,“customerPaid”:{“单元”:“美元”,“价值”:6099,“字符串”:“60.99”},“netAmount”:{“单元”:“美元”,“价值”:5892,“字符串”:“58.92”},“requiresShipping”:真正的,“shippingProvider”:零,“shippingTracking”:零,“customerInfo”:{“fullName”:“Customerio以”,“电子邮件”:“任+ customer@www.raktarban.com”},“allAddresses”:[{“类型”:“账单”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},{“类型”:“运输”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”}],“shippingAddress”:{“类型”:“运输”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},“billingAddress”:{“类型”:“账单”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},“purchasedItems”:[{“数”:1,“rowTotal”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“欧宝体育在线首页productId”:“5 eb9fd05caef491eb9757183”,“欧宝体育在线首页productName”:“白杯”,“欧宝体育在线首页productSlug”:“白色杯子”,“variantId”:“5 eb9fcace279761d8199790c”,“variantName”:“white-cup_default_sku”,“variantSlug”:“white-cup-default-sku”,“variantImage”:{“文件标识”:“5 bfedb42bab0ad90fa7dad2e”,“url”:“https://d1otoma47x30pg.cloudfront.net/5bfedb42bab0ad90fa7dac03/5bfedb42bab0ad90fa7dad2e_5bb3d019b3465c6e8a324dd7_458036-unsplas.png”},“variantPrice”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“高度”:7,“长度”:2,“重量”:5,“宽度”:4}],“purchasedItemsCount”:1,“stripeDetails”:{“refundReason”:零,“refundId”:零,“disputeId”:零,“chargeId”:“ch_1DdPYQKMjGA7k9mI2AKiBY6u”,“customerId”:“cus_E5ajeiWNHEtcAW”},“stripeCard”:{“last4”:“4242”,“品牌”:“签证”,“ownerName”:“Customerio以”,“过期”:{“年”:2023,“月”:12}},“总数”:{“小计”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“临时演员”:[{“类型”:“税”,“名称”:“国家税收”,“描述”:”“CA税(6.25%),“价格”:{“单元”:“美元”,“价值”:344,“字符串”:“3.44”}},{“类型”:“税”,“名称”:“县税”,“描述”:洛杉矶税(1.00%),“价格”:{“单元”:“美元”,“价值”:55,“字符串”:“0.55”}},{“类型”:“税”,“名称”:“特别区税”,“描述”:特别地区税(2.25%),“价格”:{“单元”:“美元”,“价值”:124,“字符串”:“1.24”}},{“类型”:“运输”,“名称”:“平率”,“描述”:"",“价格”:{“单元”:“美元”,“价值”:599,“字符串”:“5.99”}},{“类型”:“折扣”,“名称”:“折扣(SAVE5)”,“描述”:"",“价格”:{“单元”:“美元”,“价值”:-500年,“字符串”:”——5.00美元”}}],“总”:{“单元”:“美元”,“价值”:6122,“字符串”:“61.22”}},“customData”:[{“textInput”:“(415)123 - 4567”,“名称”:“电话”},{“文本区域”:“妈妈生日快乐!”,“名称”:“礼物注意”},{“复选框”:真正的,“名称”:“送礼物”}],“downloadFiles”:[{“id”:“5 e9a5eba75e0ac242e1b6f64”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“//www.raktarban.com/dashboard/download-digital-欧宝体育在线首页product?payload=5d93ba5e38c6b0160ab711d3; e7634a; 5 eb1aac72912ec06f561278c; 5 e9a5eba75e0ac242e1b6f63: ka2nehxy: 4 a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa”},{“id”:“5 e9a5eba75e0ac242e1b6f63”,“名称”:自由网页设计师指南- Webflow电子书。pdf,“url”:“//www.raktarban.com/dashboard/download-digital-欧宝体育在线首页product?payload=5d93ba5e38c6b0160ab711d3; e7634a; 5 dd44c493543b37d5449b3cd; 5 e9a5eba75e0ac242e1b6f63: ka2nehxy: 6 af5adf7c6fff7a3b0f54404fac1be492ac6f1ed5340416f1fe27c5fd4dd8079”}]}
的名字 | 类型 | 描述 |
---|---|---|
orderId |
字符串 | 订单id。通常是6个十六进制字符,但如果网站有大量的订单,也可以是9个十六进制字符。随机分配。 |
状态 |
字符串 | 之一等待 ,未实现的 ,实现了 ,有争议的 ,dispute-lost ,或退还 |
评论 |
字符串 | 此订单的注释字符串,可由API用户编辑(Webflow不使用)。 |
orderComment |
字符串 | 顾客在下单时留下的注释 |
acceptedOn |
字符串 | 下单的ISO8601时间戳。 |
disputedOn |
字符串 | 如果客户对订单有争议,那么该密钥将设置为ISO8601时间戳,Stripe将通知Webflow。如果没有争议,则为空。 |
disputeUpdatedOn |
字符串 | 如果客户对订单有争议,那么这个密钥将使用我们最后一次获得更新的ISO8601时间戳设置。如果没有争议,则为空。 |
disputeLastStatus |
字符串 | 如果客户对订单有异议,则将设置此键 |
与争议的地位. | ||
fulfilledOn |
字符串 | 如果订单被标记为“已完成”,那么这是发生时的ISO8601时间戳。 |
refundedOn |
字符串 | 如果订单被退款,这是发生时间的ISO8601。 |
customerPaid |
OrderAmount | 的实例OrderAmount对象。 |
netAmount |
OrderAmount | 的实例OrderAmount对象。 |
requiresShipping |
布尔 | 一个布尔值,指示订单是否包含一个或多个需要运输的已购买项目。 |
shippingProvider |
字符串 | API用户可编辑的字符串,以说明使用的运输提供程序(Webflow不使用)。 |
shippingTracking |
字符串 | API用户可编辑的字符串,用于记录订单的发货跟踪编号(Webflow不使用)。 |
customerInfo |
OrderCustomerInfo | 的实例OrderCustomerInfo对象。 |
allAddresses |
[OrderAddress] | 客户在订购流程中提供的所有地址。 |
shippingAddress |
OrderAddress | 的实例OrderAddress对象。 |
billingAddress |
OrderAddress | 的实例OrderAddress对象。 |
purchasedItems |
[OrderPurchasedItem] | 顾客购买的所有东西的数组。 |
stripeDetails |
StripeDetails | 的实例StripeDetails对象。 |
stripeCard |
StripeCard | 的实例StripeCard对象。 |
总数 |
OrderTotals | 的实例OrderTotals对象。 |
customData |
(对象) | 用于自定义订单数据收集的附加输入数组。数组中的每个对象都表示一个具有名称和texttinput、textArea或复选框值的输入。 |
downloadFiles |
[OrderDownloadedFile] | 可下载文件对象的数组。 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
履行订单
将订单状态更新为已完成
请求
POST /网站/: site_id/订单/: order_id/实现
参数
壳牌的例子
请求POST \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415/fulfill \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”\——头“application / json内容类型:\——数据'{" sendorder兑现邮件":false}'
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“职位”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415/fulfill”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”,“内容类型”:“application / json”},身体: {sendOrderFulfilledEmail:假},json:真正的};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”)有效载荷=”{\“sendOrderFulfilledEmail \”:假}”头= {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”,“内容类型”:“application / json”} conn.request (“职位”,“/网站/ 580 e63e98c9a982ac9b8b741 /订单/ 5 e8518516e147040726cc415 /满足”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415/fulfill”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”请求(“内容类型”] =“application / json”请求。身体=”{\“sendOrderFulfilledEmail \”:假}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”“弦”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415/fulfill”有效载荷:=字符串。NewReader (”{\“sendOrderFulfilledEmail \”:假}”) req, _:= http。NewRequest (“职位”(url,有效载荷)“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”) req.Header.Add (“内容类型”,“application / json”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415/fulfill”);var请求=新RestRequest (Method.POST);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);请求。AddHeader (“内容类型”,“application / json”);请求。AddParameter (“application / json”,”{\“sendOrderFulfilledEmail \”:假}”, ParameterType.RequestBody);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
order_id |
路径 | 字符串 | 真正的 | 订单的唯一标识符 |
sendOrderFulfilledEmail |
身体 | 布尔 | 假 | 是否应该发送订单已完成的电子邮件 |
响应
示例响应
{“orderId”:“dfa-3f1”,“状态”:“未实现”,“评论”:"",“orderComment”:"",“acceptedOn”:“2018 - 12 - 03 - t22:06:15.761z”,“disputedOn”:零,“disputeUpdatedOn”:零,“disputeLastStatus”:零,“fulfilledOn”:零,“refundedOn”:零,“customerPaid”:{“单元”:“美元”,“价值”:6099,“字符串”:“60.99”},“netAmount”:{“单元”:“美元”,“价值”:5892,“字符串”:“58.92”},“requiresShipping”:真正的,“shippingProvider”:零,“shippingTracking”:零,“customerInfo”:{“fullName”:“Customerio以”,“电子邮件”:“任+ customer@www.raktarban.com”},“allAddresses”:[{“类型”:“账单”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},{“类型”:“运输”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”}],“shippingAddress”:{“类型”:“运输”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},“billingAddress”:{“类型”:“账单”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},“purchasedItems”:[{“数”:1,“rowTotal”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“欧宝体育在线首页productId”:“5 eb9fd05caef491eb9757183”,“欧宝体育在线首页productName”:“白杯”,“欧宝体育在线首页productSlug”:“白色杯子”,“variantId”:“5 eb9fcace279761d8199790c”,“variantName”:“white-cup_default_sku”,“variantSlug”:“white-cup-default-sku”,“variantImage”:{“文件标识”:“5 bfedb42bab0ad90fa7dad2e”,“url”:“https://d1otoma47x30pg.cloudfront.net/5bfedb42bab0ad90fa7dac03/5bfedb42bab0ad90fa7dad2e_5bb3d019b3465c6e8a324dd7_458036-unsplas.png”},“variantPrice”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“高度”:7,“长度”:2,“重量”:5,“宽度”:4}],“purchasedItemsCount”:1,“stripeDetails”:{“refundReason”:零,“refundId”:零,“disputeId”:零,“chargeId”:“ch_1DdPYQKMjGA7k9mI2AKiBY6u”,“customerId”:“cus_E5ajeiWNHEtcAW”},“stripeCard”:{“last4”:“4242”,“品牌”:“签证”,“ownerName”:“Customerio以”,“过期”:{“年”:2023,“月”:12}},“总数”:{“小计”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“临时演员”:[{“类型”:“税”,“名称”:“国家税收”,“描述”:”“CA税(6.25%),“价格”:{“单元”:“美元”,“价值”:344,“字符串”:“3.44”}},{“类型”:“税”,“名称”:“县税”,“描述”:洛杉矶税(1.00%),“价格”:{“单元”:“美元”,“价值”:55,“字符串”:“0.55”}},{“类型”:“税”,“名称”:“特别区税”,“描述”:特别地区税(2.25%),“价格”:{“单元”:“美元”,“价值”:124,“字符串”:“1.24”}},{“类型”:“运输”,“名称”:“平率”,“描述”:"",“价格”:{“单元”:“美元”,“价值”:599,“字符串”:“5.99”}},{“类型”:“折扣”,“名称”:“折扣(SAVE5)”,“描述”:"",“价格”:{“单元”:“美元”,“价值”:-500年,“字符串”:”——5.00美元”}}],“总”:{“单元”:“美元”,“价值”:6122,“字符串”:“61.22”}},“customData”:[{“textInput”:“(415)123 - 4567”,“名称”:“电话”},{“文本区域”:“妈妈生日快乐!”,“名称”:“礼物注意”},{“复选框”:真正的,“名称”:“送礼物”}],“downloadFiles”:[{“id”:“5 e9a5eba75e0ac242e1b6f64”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“//www.raktarban.com/dashboard/download-digital-欧宝体育在线首页product?payload=5d93ba5e38c6b0160ab711d3; e7634a; 5 eb1aac72912ec06f561278c; 5 e9a5eba75e0ac242e1b6f63: ka2nehxy: 4 a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa”},{“id”:“5 e9a5eba75e0ac242e1b6f63”,“名称”:自由网页设计师指南- Webflow电子书。pdf,“url”:“//www.raktarban.com/dashboard/download-digital-欧宝体育在线首页product?payload=5d93ba5e38c6b0160ab711d3; e7634a; 5 dd44c493543b37d5449b3cd; 5 e9a5eba75e0ac242e1b6f63: ka2nehxy: 6 af5adf7c6fff7a3b0f54404fac1be492ac6f1ed5340416f1fe27c5fd4dd8079”}]}
的名字 | 类型 | 描述 |
---|---|---|
orderId |
字符串 | 订单id。通常是6个十六进制字符,但如果网站有大量的订单,也可以是9个十六进制字符。随机分配。 |
状态 |
字符串 | 之一等待 ,未实现的 ,实现了 ,有争议的 ,dispute-lost ,或退还 |
评论 |
字符串 | 此订单的注释字符串,可由API用户编辑(Webflow不使用)。 |
orderComment |
字符串 | 顾客在下单时留下的注释 |
acceptedOn |
字符串 | 下单的ISO8601时间戳。 |
disputedOn |
字符串 | 如果客户对订单有争议,那么该密钥将设置为ISO8601时间戳,Stripe将通知Webflow。如果没有争议,则为空。 |
disputeUpdatedOn |
字符串 | 如果客户对订单有争议,那么这个密钥将使用我们最后一次获得更新的ISO8601时间戳设置。如果没有争议,则为空。 |
disputeLastStatus |
字符串 | 如果客户对订单有异议,则将设置此键 |
与争议的地位. | ||
fulfilledOn |
字符串 | 如果订单被标记为“已完成”,那么这是发生时的ISO8601时间戳。 |
refundedOn |
字符串 | 如果订单被退款,这是发生时间的ISO8601。 |
customerPaid |
OrderAmount | 的实例OrderAmount对象。 |
netAmount |
OrderAmount | 的实例OrderAmount对象。 |
requiresShipping |
布尔 | 一个布尔值,指示订单是否包含一个或多个需要运输的已购买项目。 |
shippingProvider |
字符串 | API用户可编辑的字符串,以说明使用的运输提供程序(Webflow不使用)。 |
shippingTracking |
字符串 | API用户可编辑的字符串,用于记录订单的发货跟踪编号(Webflow不使用)。 |
customerInfo |
OrderCustomerInfo | 的实例OrderCustomerInfo对象。 |
allAddresses |
[OrderAddress] | 客户在订购流程中提供的所有地址。 |
shippingAddress |
OrderAddress | 的实例OrderAddress对象。 |
billingAddress |
OrderAddress | 的实例OrderAddress对象。 |
purchasedItems |
[OrderPurchasedItem] | 顾客购买的所有东西的数组。 |
stripeDetails |
StripeDetails | 的实例StripeDetails对象。 |
stripeCard |
StripeCard | 的实例StripeCard对象。 |
总数 |
OrderTotals | 的实例OrderTotals对象。 |
customData |
(对象) | 用于自定义订单数据收集的附加输入数组。数组中的每个对象都表示一个具有名称和texttinput、textArea或复选框值的输入。 |
downloadFiles |
[OrderDownloadedFile] | 可下载文件对象的数组。 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
Unfulfill秩序
将订单状态更新为未完成状态
请求
POST /网站/: site_id/订单/: order_id/ unfulfill
参数
壳牌的例子
请求POST \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415/unfulfill \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“职位”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415/unfulfill”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“职位”,“/网站/ 580 e63e98c9a982ac9b8b741 /订单/ 5 e8518516e147040726cc415 / unfulfill”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415/unfulfill”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415/unfulfill”Req, _:= http。NewRequest (“职位”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415/unfulfill”);var请求=新RestRequest (Method.POST);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
order_id |
路径 | 字符串 | 真正的 | 订单的唯一标识符 |
响应
示例响应
{“orderId”:“dfa-3f1”,“状态”:“未实现”,“评论”:"",“orderComment”:"",“acceptedOn”:“2018 - 12 - 03 - t22:06:15.761z”,“disputedOn”:零,“disputeUpdatedOn”:零,“disputeLastStatus”:零,“fulfilledOn”:零,“refundedOn”:零,“customerPaid”:{“单元”:“美元”,“价值”:6099,“字符串”:“60.99”},“netAmount”:{“单元”:“美元”,“价值”:5892,“字符串”:“58.92”},“requiresShipping”:真正的,“shippingProvider”:零,“shippingTracking”:零,“customerInfo”:{“fullName”:“Customerio以”,“电子邮件”:“任+ customer@www.raktarban.com”},“allAddresses”:[{“类型”:“账单”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},{“类型”:“运输”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”}],“shippingAddress”:{“类型”:“运输”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},“billingAddress”:{“类型”:“账单”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},“purchasedItems”:[{“数”:1,“rowTotal”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“欧宝体育在线首页productId”:“5 eb9fd05caef491eb9757183”,“欧宝体育在线首页productName”:“白杯”,“欧宝体育在线首页productSlug”:“白色杯子”,“variantId”:“5 eb9fcace279761d8199790c”,“variantName”:“white-cup_default_sku”,“variantSlug”:“white-cup-default-sku”,“variantImage”:{“文件标识”:“5 bfedb42bab0ad90fa7dad2e”,“url”:“https://d1otoma47x30pg.cloudfront.net/5bfedb42bab0ad90fa7dac03/5bfedb42bab0ad90fa7dad2e_5bb3d019b3465c6e8a324dd7_458036-unsplas.png”},“variantPrice”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“高度”:7,“长度”:2,“重量”:5,“宽度”:4}],“purchasedItemsCount”:1,“stripeDetails”:{“refundReason”:零,“refundId”:零,“disputeId”:零,“chargeId”:“ch_1DdPYQKMjGA7k9mI2AKiBY6u”,“customerId”:“cus_E5ajeiWNHEtcAW”},“stripeCard”:{“last4”:“4242”,“品牌”:“签证”,“ownerName”:“Customerio以”,“过期”:{“年”:2023,“月”:12}},“总数”:{“小计”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“临时演员”:[{“类型”:“税”,“名称”:“国家税收”,“描述”:”“CA税(6.25%),“价格”:{“单元”:“美元”,“价值”:344,“字符串”:“3.44”}},{“类型”:“税”,“名称”:“县税”,“描述”:洛杉矶税(1.00%),“价格”:{“单元”:“美元”,“价值”:55,“字符串”:“0.55”}},{“类型”:“税”,“名称”:“特别区税”,“描述”:特别地区税(2.25%),“价格”:{“单元”:“美元”,“价值”:124,“字符串”:“1.24”}},{“类型”:“运输”,“名称”:“平率”,“描述”:"",“价格”:{“单元”:“美元”,“价值”:599,“字符串”:“5.99”}},{“类型”:“折扣”,“名称”:“折扣(SAVE5)”,“描述”:"",“价格”:{“单元”:“美元”,“价值”:-500年,“字符串”:”——5.00美元”}}],“总”:{“单元”:“美元”,“价值”:6122,“字符串”:“61.22”}},“customData”:[{“textInput”:“(415)123 - 4567”,“名称”:“电话”},{“文本区域”:“妈妈生日快乐!”,“名称”:“礼物注意”},{“复选框”:真正的,“名称”:“送礼物”}],“downloadFiles”:[{“id”:“5 e9a5eba75e0ac242e1b6f64”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“//www.raktarban.com/dashboard/download-digital-欧宝体育在线首页product?payload=5d93ba5e38c6b0160ab711d3; e7634a; 5 eb1aac72912ec06f561278c; 5 e9a5eba75e0ac242e1b6f63: ka2nehxy: 4 a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa”},{“id”:“5 e9a5eba75e0ac242e1b6f63”,“名称”:自由网页设计师指南- Webflow电子书。pdf,“url”:“//www.raktarban.com/dashboard/download-digital-欧宝体育在线首页product?payload=5d93ba5e38c6b0160ab711d3; e7634a; 5 dd44c493543b37d5449b3cd; 5 e9a5eba75e0ac242e1b6f63: ka2nehxy: 6 af5adf7c6fff7a3b0f54404fac1be492ac6f1ed5340416f1fe27c5fd4dd8079”}]}
的名字 | 类型 | 描述 |
---|---|---|
orderId |
字符串 | 订单id。通常是6个十六进制字符,但如果网站有大量的订单,也可以是9个十六进制字符。随机分配。 |
状态 |
字符串 | 之一等待 ,未实现的 ,实现了 ,有争议的 ,dispute-lost ,或退还 |
评论 |
字符串 | 此订单的注释字符串,可由API用户编辑(Webflow不使用)。 |
orderComment |
字符串 | 顾客在下单时留下的注释 |
acceptedOn |
字符串 | 下单的ISO8601时间戳。 |
disputedOn |
字符串 | 如果客户对订单有争议,那么该密钥将设置为ISO8601时间戳,Stripe将通知Webflow。如果没有争议,则为空。 |
disputeUpdatedOn |
字符串 | 如果客户对订单有争议,那么这个密钥将使用我们最后一次获得更新的ISO8601时间戳设置。如果没有争议,则为空。 |
disputeLastStatus |
字符串 | 如果客户对订单有异议,则将设置此键 |
与争议的地位. | ||
fulfilledOn |
字符串 | 如果订单被标记为“已完成”,那么这是发生时的ISO8601时间戳。 |
refundedOn |
字符串 | 如果订单被退款,这是发生时间的ISO8601。 |
customerPaid |
OrderAmount | 的实例OrderAmount对象。 |
netAmount |
OrderAmount | 的实例OrderAmount对象。 |
requiresShipping |
布尔 | 一个布尔值,指示订单是否包含一个或多个需要运输的已购买项目。 |
shippingProvider |
字符串 | API用户可编辑的字符串,以说明使用的运输提供程序(Webflow不使用)。 |
shippingTracking |
字符串 | API用户可编辑的字符串,用于记录订单的发货跟踪编号(Webflow不使用)。 |
customerInfo |
OrderCustomerInfo | 的实例OrderCustomerInfo对象。 |
allAddresses |
[OrderAddress] | 客户在订购流程中提供的所有地址。 |
shippingAddress |
OrderAddress | 的实例OrderAddress对象。 |
billingAddress |
OrderAddress | 的实例OrderAddress对象。 |
purchasedItems |
[OrderPurchasedItem] | 顾客购买的所有东西的数组。 |
stripeDetails |
StripeDetails | 的实例StripeDetails对象。 |
stripeCard |
StripeCard | 的实例StripeCard对象。 |
总数 |
OrderTotals | 的实例OrderTotals对象。 |
customData |
(对象) | 用于自定义订单数据收集的附加输入数组。数组中的每个对象都表示一个具有名称和texttinput、textArea或复选框值的输入。 |
downloadFiles |
[OrderDownloadedFile] | 可下载文件对象的数组。 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
退款订单
该API将撤销Stripe费用并将订单退还给客户。它还将把订单的状态设置为退还
.
请求
POST /网站/: site_id/订单/: order_id/退款
参数
壳牌的例子
请求POST \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415/refund \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“职位”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415/refund”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“职位”,“/网站/ 580 e63e98c9a982ac9b8b741 /订单/ 5 e8518516e147040726cc415 /退款”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415/refund”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415/refund”Req, _:= http。NewRequest (“职位”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/order/5e8518516e147040726cc415/refund”);var请求=新RestRequest (Method.POST);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
order_id |
路径 | 字符串 | 真正的 | 订单的唯一标识符 |
响应
示例响应
{“orderId”:“dfa-3f1”,“状态”:“未实现”,“评论”:"",“orderComment”:"",“acceptedOn”:“2018 - 12 - 03 - t22:06:15.761z”,“disputedOn”:零,“disputeUpdatedOn”:零,“disputeLastStatus”:零,“fulfilledOn”:零,“refundedOn”:零,“customerPaid”:{“单元”:“美元”,“价值”:6099,“字符串”:“60.99”},“netAmount”:{“单元”:“美元”,“价值”:5892,“字符串”:“58.92”},“requiresShipping”:真正的,“shippingProvider”:零,“shippingTracking”:零,“customerInfo”:{“fullName”:“Customerio以”,“电子邮件”:“任+ customer@www.raktarban.com”},“allAddresses”:[{“类型”:“账单”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},{“类型”:“运输”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”}],“shippingAddress”:{“类型”:“运输”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},“billingAddress”:{“类型”:“账单”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},“purchasedItems”:[{“数”:1,“rowTotal”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“欧宝体育在线首页productId”:“5 eb9fd05caef491eb9757183”,“欧宝体育在线首页productName”:“白杯”,“欧宝体育在线首页productSlug”:“白色杯子”,“variantId”:“5 eb9fcace279761d8199790c”,“variantName”:“white-cup_default_sku”,“variantSlug”:“white-cup-default-sku”,“variantImage”:{“文件标识”:“5 bfedb42bab0ad90fa7dad2e”,“url”:“https://d1otoma47x30pg.cloudfront.net/5bfedb42bab0ad90fa7dac03/5bfedb42bab0ad90fa7dad2e_5bb3d019b3465c6e8a324dd7_458036-unsplas.png”},“variantPrice”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“高度”:7,“长度”:2,“重量”:5,“宽度”:4}],“purchasedItemsCount”:1,“stripeDetails”:{“refundReason”:零,“refundId”:零,“disputeId”:零,“chargeId”:“ch_1DdPYQKMjGA7k9mI2AKiBY6u”,“customerId”:“cus_E5ajeiWNHEtcAW”},“stripeCard”:{“last4”:“4242”,“品牌”:“签证”,“ownerName”:“Customerio以”,“过期”:{“年”:2023,“月”:12}},“总数”:{“小计”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“临时演员”:[{“类型”:“税”,“名称”:“国家税收”,“描述”:”“CA税(6.25%),“价格”:{“单元”:“美元”,“价值”:344,“字符串”:“3.44”}},{“类型”:“税”,“名称”:“县税”,“描述”:洛杉矶税(1.00%),“价格”:{“单元”:“美元”,“价值”:55,“字符串”:“0.55”}},{“类型”:“税”,“名称”:“特别区税”,“描述”:特别地区税(2.25%),“价格”:{“单元”:“美元”,“价值”:124,“字符串”:“1.24”}},{“类型”:“运输”,“名称”:“平率”,“描述”:"",“价格”:{“单元”:“美元”,“价值”:599,“字符串”:“5.99”}},{“类型”:“折扣”,“名称”:“折扣(SAVE5)”,“描述”:"",“价格”:{“单元”:“美元”,“价值”:-500年,“字符串”:”——5.00美元”}}],“总”:{“单元”:“美元”,“价值”:6122,“字符串”:“61.22”}},“customData”:[{“textInput”:“(415)123 - 4567”,“名称”:“电话”},{“文本区域”:“妈妈生日快乐!”,“名称”:“礼物注意”},{“复选框”:真正的,“名称”:“送礼物”}],“downloadFiles”:[{“id”:“5 e9a5eba75e0ac242e1b6f64”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“//www.raktarban.com/dashboard/download-digital-欧宝体育在线首页product?payload=5d93ba5e38c6b0160ab711d3; e7634a; 5 eb1aac72912ec06f561278c; 5 e9a5eba75e0ac242e1b6f63: ka2nehxy: 4 a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa”},{“id”:“5 e9a5eba75e0ac242e1b6f63”,“名称”:自由网页设计师指南- Webflow电子书。pdf,“url”:“//www.raktarban.com/dashboard/download-digital-欧宝体育在线首页product?payload=5d93ba5e38c6b0160ab711d3; e7634a; 5 dd44c493543b37d5449b3cd; 5 e9a5eba75e0ac242e1b6f63: ka2nehxy: 6 af5adf7c6fff7a3b0f54404fac1be492ac6f1ed5340416f1fe27c5fd4dd8079”}]}
的名字 | 类型 | 描述 |
---|---|---|
orderId |
字符串 | 订单id。通常是6个十六进制字符,但如果网站有大量的订单,也可以是9个十六进制字符。随机分配。 |
状态 |
字符串 | 之一等待 ,未实现的 ,实现了 ,有争议的 ,dispute-lost ,或退还 |
评论 |
字符串 | 此订单的注释字符串,可由API用户编辑(Webflow不使用)。 |
orderComment |
字符串 | 顾客在下单时留下的注释 |
acceptedOn |
字符串 | 下单的ISO8601时间戳。 |
disputedOn |
字符串 | 如果客户对订单有争议,那么该密钥将设置为ISO8601时间戳,Stripe将通知Webflow。如果没有争议,则为空。 |
disputeUpdatedOn |
字符串 | 如果客户对订单有争议,那么这个密钥将使用我们最后一次获得更新的ISO8601时间戳设置。如果没有争议,则为空。 |
disputeLastStatus |
字符串 | 如果客户对订单有异议,则将设置此键 |
与争议的地位. | ||
fulfilledOn |
字符串 | 如果订单被标记为“已完成”,那么这是发生时的ISO8601时间戳。 |
refundedOn |
字符串 | 如果订单被退款,这是发生时间的ISO8601。 |
customerPaid |
OrderAmount | 的实例OrderAmount对象。 |
netAmount |
OrderAmount | 的实例OrderAmount对象。 |
requiresShipping |
布尔 | 一个布尔值,指示订单是否包含一个或多个需要运输的已购买项目。 |
shippingProvider |
字符串 | API用户可编辑的字符串,以说明使用的运输提供程序(Webflow不使用)。 |
shippingTracking |
字符串 | API用户可编辑的字符串,用于记录订单的发货跟踪编号(Webflow不使用)。 |
customerInfo |
OrderCustomerInfo | 的实例OrderCustomerInfo对象。 |
allAddresses |
[OrderAddress] | 客户在订购流程中提供的所有地址。 |
shippingAddress |
OrderAddress | 的实例OrderAddress对象。 |
billingAddress |
OrderAddress | 的实例OrderAddress对象。 |
purchasedItems |
[OrderPurchasedItem] | 顾客购买的所有东西的数组。 |
stripeDetails |
StripeDetails | 的实例StripeDetails对象。 |
stripeCard |
StripeCard | 的实例StripeCard对象。 |
总数 |
OrderTotals | 的实例OrderTotals对象。 |
customData |
(对象) | 用于自定义订单数据收集的附加输入数组。数组中的每个对象都表示一个具有名称和texttinput、textArea或复选框值的输入。 |
downloadFiles |
[OrderDownloadedFile] | 可下载文件对象的数组。 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
库存
库存列表
列出特定SKU项目的当前库存水平。
请求
获得/收藏/: collection_id/项目/: item_id/库存
参数
壳牌的例子
curl -request GET \——url https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754/inventory \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754/inventory”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“/收藏/ 580 e63fc8c9a982ac9b8b745 /项目/ 580 e64008c9a982ac9b8b754 /库存”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754/inventory”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754/inventory”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754/inventory”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
collection_id |
路径 | 字符串 | 真正的 | 集合的唯一标识符 |
item_id |
路径 | 字符串 | 真正的 | 和项的唯一标识符 |
响应
示例响应
{“_id”:“5 bfedb42bab0ad90fa7dad39”,“数量”:83,“inventoryType”:“有限”}
的名字 | 类型 | 描述 |
---|---|---|
_id |
字符串 | SKU项的唯一标识符 |
数量 |
数量 | 存货中剩余物品的总数(如果有限) |
inventoryType |
字符串 | 无限和有限 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
更新项目的库存
更新特定SKU项目的当前库存水平。更新可以通过一到两个方法进行,绝对的或增量的。绝对更新是通过设置完成的数量
直接。的增量更新是通过指定库存增量来实现的updateQuantity
然后添加到数量
存储在服务器上。
请求
补丁/收藏/: collection_id/项目/: item_id/库存
参数
壳牌的例子
curl -request PATCH \——url https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754/inventory \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”\——头“application / json内容类型:\——数据{"fields": {"inventoryType": "finite", "updateQuantity": 1, "quantity": 100}}
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“补丁”,url:“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754/inventory”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”,“内容类型”:“application / json”},身体: {字段: {inventoryType:“有限”,updateQuantity:1,数量:One hundred.}},json:真正的};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”)有效载荷=“{\”字段\”:{\“inventoryType \”,\“有限\”,\“updateQuantity \”:1,\“数量\”:100}}”头= {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”,“内容类型”:“application / json”} conn.request (“补丁”,“/收藏/ 580 e63fc8c9a982ac9b8b745 /项目/ 580 e64008c9a982ac9b8b754 /库存”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754/inventory”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::补丁格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”请求(“内容类型”] =“application / json”请求。身体=“{\”字段\”:{\“inventoryType \”,\“有限\”,\“updateQuantity \”:1,\“数量\”:100}}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”“弦”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754/inventory”有效载荷:=字符串。NewReader (“{\”字段\”:{\“inventoryType \”,\“有限\”,\“updateQuantity \”:1,\“数量\”:100}}”) req, _:= http。NewRequest (“补丁”(url,有效载荷)“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”) req.Header.Add (“内容类型”,“application / json”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/collections/580e63fc8c9a982ac9b8b745/items/580e64008c9a982ac9b8b754/inventory”);var请求=新RestRequest (Method.PATCH);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);请求。AddHeader (“内容类型”,“application / json”);请求。AddParameter (“application / json”,“{\”字段\”:{\“inventoryType \”,\“有限\”,\“updateQuantity \”:1,\“数量\”:100}}”, ParameterType.RequestBody);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
collection_id |
路径 | 字符串 | 真正的 | 集合的唯一标识符 |
item_id |
路径 | 字符串 | 真正的 | 和项的唯一标识符 |
字段 |
身体 | 对象 | 假 | 要更新的库存字段 |
响应
示例响应
{“_id”:“5 bfedb42bab0ad90fa7dad39”,“数量”:83,“inventoryType”:“有限”}
的名字 | 类型 | 描述 |
---|---|---|
_id |
字符串 | SKU项的唯一标识符 |
数量 |
数量 | 存货中剩余物品的总数(如果有限) |
inventoryType |
字符串 | 无限和有限 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
设置
获得电子商务设置
检索网站的电子商务设置。
请求
获得/网站/: site_id/电子商务/设置
参数
壳牌的例子
curl -request GET \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/ecommerce/settings \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/ecommerce/settings”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“/网站/ 580 e63e98c9a982ac9b8b741 /电子商务/设置”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/ecommerce/settings”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/ecommerce/settings”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/ecommerce/settings”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
响应
示例响应
{“createdOn”:“2019 - 02 - 21 - t18:41:47.312z”,“网站”:“62 f3b1f7eafbc45d0c64ef93”,“defaultCurrency”:“美元”}
的名字 | 类型 | 描述 |
---|---|---|
createdOn |
字符串 | 网站创建的日期 |
网站 |
字符串 | 需要查询的站点id |
defaultCurrency |
字符串 | 网站的三字母货币代码 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
人则
人列表
所有webhook在一个给定的网站的列表
请求
获得/网站/: site_id/人
参数
壳牌的例子
curl -request GET \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“/网站/ 580 e63e98c9a982ac9b8b741 /人”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
响应
示例响应
[{“_id”:“57 ca0a9e418c504a6e1acbb6”,“triggerType”:“form_submission”,“triggerId”:“562 ac0395358780a1f5e6fbd”,“网站”:“562 ac0395358780a1f5e6fbd”,“过滤”:{“名称”:“电子邮件形式”},“lastUsed”:“2016 - 09 - 06 - t21:12:22.148z”,“createdOn”:“2016 - 09 - 02 - t23:26:22.241z”},{“_id”:“578 d85cce0c47cd2865f4cf2”,“triggerType”:“form_submission”,“triggerId”:“562 ac0395358780a1f5e6fbd”,“网站”:“562 ac0395358780a1f5e6fbd”,“过滤”:{“名称”:“电子邮件形式”},“lastUsed”:“2016 - 09 - 06 - t21:12:22.142z”,“createdOn”:“2016 - 07 - 19 t01:43:40.585z”},{“_id”:“578 d85cce0c47cd2865f4cf3”,“triggerType”:“form_submission”,“triggerId”:“562 ac0395358780a1f5e6fbd”,“网站”:“562 ac0395358780a1f5e6fbd”,“过滤”:{“名称”:“电子邮件形式”},“lastUsed”:“2016 - 09 - 06 - t21:12:22.192z”,“createdOn”:“2016 - 07 - 19 t01:43:40.605z”}]
的名字 | 类型 | 描述 |
---|---|---|
_id |
字符串 | Webhook的唯一标识符 |
triggerType |
TriggerType | 的实例TriggerType对象。 |
triggerId |
字符串 | Webhook Trigger的唯一标识符 |
网站 |
字符串 | Webhook的唯一标识符 |
过滤器 |
对象 | 过滤器用于选择你想要为哪些事件触发webhook。 |
lastUsed |
字符串 | 日期触发器最后一次使用 |
createdOn |
字符串 | 创建了日期触发器 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
创建Webhook
创建一个新的webhook
请求
POST /网站/: site_id/人
参数
壳牌的例子
请求POST \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”\——头“application / json内容类型:\——数据“{"triggerType": "form_submission", "url": "https://api.mydomain.com/webhook", "filter": {"name": "Email Form"}}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“职位”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”,“内容类型”:“application / json”},身体: {triggerType:“form_submission”,url:“https://api.mydomain.com/webhook”,过滤器: {的名字:“电子邮件形式”}},json:真正的};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”)有效载荷=“{\“triggerType \”,\“form_submission \”,\“url \”:\“https://api.mydomain.com/webhook \”,\“过滤\”:{\“\”:\“电子邮件形式\”}}”头= {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”,“内容类型”:“application / json”} conn.request (“职位”,“/网站/ 580 e63e98c9a982ac9b8b741 /人”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”请求(“内容类型”] =“application / json”请求。身体=“{\“triggerType \”,\“form_submission \”,\“url \”:\“https://api.mydomain.com/webhook \”,\“过滤\”:{\“\”:\“电子邮件形式\”}}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”“弦”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks”有效载荷:=字符串。NewReader (“{\“triggerType \”,\“form_submission \”,\“url \”:\“https://api.mydomain.com/webhook \”,\“过滤\”:{\“\”:\“电子邮件形式\”}}”) req, _:= http。NewRequest (“职位”(url,有效载荷)“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”) req.Header.Add (“内容类型”,“application / json”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks”);var请求=新RestRequest (Method.POST);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);请求。AddHeader (“内容类型”,“application / json”);请求。AddParameter (“application / json”,“{\“triggerType \”,\“form_submission \”,\“url \”:\“https://api.mydomain.com/webhook \”,\“过滤\”:{\“\”:\“电子邮件形式\”}}”, ParameterType.RequestBody);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
triggerType |
身体 | TriggerType | 假 | 的实例TriggerType对象。 |
url |
身体 | 字符串 | 假 | 当webhook被触发时,webhook将向服务器上的https URL发送请求 |
过滤器 |
身体 | 对象 | 假 | 过滤器用于选择你想要为哪些事件触发webhook。 |
响应
示例响应
{“_id”:“582266 e0cd48de0f0e3c6d8b”,“triggerType”:“form_submission”,“triggerId”:“562 ac0395358780a1f5e6fbd”,“网站”:“562 ac0395358780a1f5e6fbd”,“createdOn”:“2016 - 11 - 08 - t23:59:28.572z”}
的名字 | 类型 | 描述 |
---|---|---|
_id |
字符串 | Webhook的唯一标识符 |
triggerType |
TriggerType | 的实例TriggerType对象。 |
triggerId |
字符串 | Webhook Trigger的唯一标识符 |
网站 |
字符串 | Webhook的唯一标识符 |
过滤器 |
对象 | 过滤器用于选择你想要为哪些事件触发webhook。 |
lastUsed |
字符串 | 日期触发器最后一次使用 |
createdOn |
字符串 | 创建了日期触发器 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
得到Webhook
获得一个网站的网络链接
请求
获得/网站/: site_id/人/: webhook_id
参数
壳牌的例子
curl -request GET \——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks/580e64008c9a982ac9b8b754 \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“得到”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks/580e64008c9a982ac9b8b754”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“获得”,“/网站/ 580 e63e98c9a982ac9b8b741 /人/ 580 e64008c9a982ac9b8b754”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks/580e64008c9a982ac9b8b754”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks/580e64008c9a982ac9b8b754”Req, _:= http。NewRequest (“获得”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks/580e64008c9a982ac9b8b754”);var请求=新RestRequest (Method.GET);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
webhook_id |
路径 | 字符串 | 真正的 | Webhook的唯一标识符 |
响应
示例响应
{“_id”:“582266 e0cd48de0f0e3c6d8b”,“triggerType”:“form_submission”,“triggerId”:“562 ac0395358780a1f5e6fbd”,“网站”:“562 ac0395358780a1f5e6fbd”,“createdOn”:“2016 - 11 - 08 - t23:59:28.572z”}
的名字 | 类型 | 描述 |
---|---|---|
_id |
字符串 | Webhook的唯一标识符 |
triggerType |
TriggerType | 的实例TriggerType对象。 |
triggerId |
字符串 | Webhook Trigger的唯一标识符 |
网站 |
字符串 | Webhook的唯一标识符 |
过滤器 |
对象 | 过滤器用于选择你想要为哪些事件触发webhook。 |
lastUsed |
字符串 | 日期触发器最后一次使用 |
createdOn |
字符串 | 创建了日期触发器 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
删除Webhook
删除一个webhook
请求
删除/网站/: site_id/人/: webhook_id
参数
壳牌的例子
请求删除\——url https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks/580e64008c9a982ac9b8b754 \——头文件“Accept-Version: 1.0.0”\——头“授权:无记名{access_token}”
Javascript的例子
常量请求=需要(“请求”);常量选择= {方法:“删除”,url:“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks/580e64008c9a982ac9b8b754”,头: {“Accept-Version”:“1.0.0”,授权:“不记名{access_token}”}};请求(选项,函数(误差、响应的身体){如果(错误)扔新错误(错误);控制台.日志(身体);});
Python示例
进口http。客户端conn = http.client. httpconnection (“api.www.raktarban.com”) headers = {“Accept-Version”:“1.0.0”,“授权”:“不记名{access_token}”} conn.request (“删除”,“/网站/ 580 e63e98c9a982ac9b8b741 /人/ 580 e64008c9a982ac9b8b754”res = conn.getresponse() data = res.read()打印(data.decode (“utf - 8”))
Ruby的例子
需要“uri”需要“net/http”需要openssl的url =URI(“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks/580e64008c9a982ac9b8b754”) http =Net:: HTTP格式(url。主机,url.port http)。use_ssl =真正的http。verify_mode = OpenSSL::SSL:: VERIFY_NONE请求=Net:: HTTP::删除格式(url)请求(“Accept-Version”] =“1.0.0”请求(“授权”] =“不记名{access_token}”Response = http.request(request)放置Response .read_body
去的例子
包主要进口(“fmt”"net/http”“io / ioutil”)函数主要(){url: =“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks/580e64008c9a982ac9b8b754”Req, _:= http。NewRequest (“删除”、url、零) req.Header.Add (“Accept-Version”,“1.0.0”) req.Header.Add (“授权”,“不记名{access_token}”_:= http.DefaultClient.Do(req)推迟res. body . close () body, _:= ioutil.ReadAll(res. body) fmt. println (res) fmt. readall (res. body)Println (字符串(身体))}
net示例
var客户=新RestClient (“https://api.www.raktarban.com/sites/580e63e98c9a982ac9b8b741/webhooks/580e64008c9a982ac9b8b754”);var请求=新RestRequest (Method.DELETE);请求。AddHeader (“Accept-Version”,“1.0.0”);请求。AddHeader (“授权”,“不记名{access_token}”);IRestResponse = client.Execute(请求);
的名字 | 在 | 类型 | 要求 | 描述 |
---|---|---|---|---|
Accept-Version |
头 | 字符串 | 假 | API版本 |
site_id |
路径 | 字符串 | 真正的 | 站点的唯一标识符 |
webhook_id |
路径 | 字符串 | 真正的 | Webhook的唯一标识符 |
响应
示例响应
{“删除”:1}
的名字 | 类型 | 描述 |
---|---|---|
删除 |
数量 | 删除的记录数量 |
响应代码
状态 | 意义 | 描述 |
---|---|---|
200 |
好吧 | 请求是成功的 |
400 |
SyntaxError | 请求正文格式不正确。可能正在发送无效的JSON。 |
401 |
未经授权的 | 所提供的访问令牌无效或无法访问所请求的资源 |
404 |
NotFound | 请求的资源未找到 |
429 |
RateLimit | 已达到所提供的access_token的速率限制。请让您的应用程序尊重我们在API响应中包含的X-RateLimit-Remaining头。 |
500 |
ServerError | 我们的服务器出了问题。稍后再试。 |
模型
AuthorizedUser
{“用户”:{“_id”:“545 bbecb7bdd6769632504a7”,“电子邮件”:“some.com”,“firstName”:“一些”,“姓”:“一”}}
场 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 用户的唯一id |
电子邮件 |
字符串 | 用户的电子邮件地址 |
firstName |
字符串 | 用户的名字 |
姓 |
字符串 | 用户的姓 |
授权
{“_id”:“55818 d58616600637b9a5786”,“createdOn”:“2016 - 10 - 03 - t23:12:00.755z”,“grantType”:“authorization_code”,“lastUsed”:“2016 - 10 - 10 - t21:41:12.736z”,“网站”:[“62 f3b1f7eafac55d0c64ef91”],“组织”:[“551 ad253f0a9c0686f71ed08”],“工作区”:[],“用户”:[“545 bbecb7bdd6769632504a7”],“rateLimit”:60,“状态”:“确认”,“应用程序”:{“_id”:“55131 cd036c09f7d07883dfc”,“描述”:“OAuth测试应用程序”,“主页”:“//www.raktarban.com”,“名称”:“测试应用程序”,“所有者”:“545 bbecb7bdd6769632504a7”,“ownerType”:“人”}}
场 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 授权的唯一id |
createdOn |
字符串 | 创建授权的日期 |
grantType |
字符串 | 授权的授予类型 |
lastUsed |
字符串 | 授权最后使用的日期 |
网站 |
(字符串) | 授权的网站 |
组织 |
(字符串) | 组织授权 |
工作区 |
(字符串) | 工作区授权 |
用户 |
(字符串) | 用户授权 |
rateLimit |
整数 | 授权的默认速率限制 |
状态 |
字符串 | 授权的状态 |
应用程序 |
应用程序 | 的实例应用程序对象。 |
应用程序
{}
场 | 类型 | 描述 |
---|---|---|
_id |
字符串 | |
描述 |
字符串 | |
主页 |
字符串 | |
的名字 |
字符串 | |
老板 |
字符串 | |
ownerType |
字符串 |
网站
{“_id”:“580 e63e98c9a982ac9b8b741”,“createdOn”:“2016 - 10 - 24 t19:41:29.156z”,“名称”:“api_docs_sample_json”,“短”:“api-docs-sample-json”,“lastPublished”:“2016 - 10 - 24 t19:43:17.271z”,“previewUrl”:“https://d1otoma47x30pg.cloudfront.net/580e63e98c9a982ac9b8b741/201610241243.png”,“时区”:“美国/ Los_Angeles”,“数据库”:“580 e63fc8c9a982ac9b8b744”}
场 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 网站的唯一标识符 |
createdOn |
字符串 | 网站创建日期 |
的名字 |
字符串 | 场地名称 |
短 |
字符串 | 名字的钝化版本 |
lastPublished |
字符串 | 上次发布的日期 |
previewUrl |
字符串 | 为给定站点生成的图像的URL |
时区 |
字符串 | 在“站点设置”中设置站点时区 |
域
{}
场 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 域的唯一标识符 |
的名字 |
字符串 | 域名 |
PublishedSite
{“排队”:真正的}
场 | 类型 | 描述 |
---|---|---|
排队 |
布尔 | 指示站点是否已排队等待发布 |
集合
{“_id”:“580 e63fc8c9a982ac9b8b745”,“lastupdate”:“2016 - 10 - 24 t19:42:38.929z”,“createdOn”:“2016 - 10 - 24 t19:41:48.349z”,“名称”:“博客”,“鼻涕虫”:“职位”,“singularName”:“博客”,“字段”:[{“id”:“7 f62a9781291109b9e428fb47239fd35”,“可编辑”:真正的,“要求”:假,“类型”:“RichText”,“鼻涕虫”:“post”,“名称”:“后的身体”},{“验证”:{“单行模式”:假},“id”:“ac4ffead755a78c710c44042f528b073”,“helpText”:“出现在博客文章网格上的博客文章摘要”,“可编辑”:真正的,“要求”:假,“类型”:“明文”,“鼻涕虫”:“post-summary”,“名称”:“后总结”},{“id”:“ba1cfbdaa6b38b8e95e9b5063da8a5bd”,“可编辑”:真正的,“要求”:假,“类型”:“ImageRef”,“鼻涕虫”:“主图片”,“名称”:“主要形象”},{“id”:“a8c6ea29b08cc5b5ef966908fa1deae2”,“helpText”:用于博客帖子网格的主图片的小版本,“可编辑”:真正的,“要求”:假,“类型”:“ImageRef”,“鼻涕虫”:“缩略图”,“名称”:“缩略图”},{“id”:“87 e79a644a6fb5729940ec24e0012f01”,“可编辑”:真正的,“要求”:假,“类型”:“设置”,“innerType”:“ImageRef”,“鼻涕虫”:“画廊”,“名称”:“画廊”},{“id”:“1 e54974d97181032d3206ea021668e5f”,“可编辑”:真正的,“要求”:假,“类型”:“Bool”,“鼻涕虫”:“特色”,“名称”:“特色?”},{“id”:“648463 cbc042ab079c2b99430a398ae5”,“可编辑”:真正的,“要求”:假,“类型”:“颜色”,“鼻涕虫”:“颜色”,“名称”:“颜色”},{“验证”:{“collectionId”:“580 e64088c9a982ac9b8b766”},“id”:“ea9067c48edee510de71fe503fa2fb51”,“可编辑”:真正的,“要求”:假,“类型”:“ItemRef”,“鼻涕虫”:“作者”,“名称”:“作者”},{“验证”:{“最大长度”:256},“id”:“60 c0667e27b6d5a6daedec3a641265f6”,“可编辑”:真正的,“要求”:真正的,“类型”:“明文”,“鼻涕虫”:“名称”,“名称”:“名称”},{“验证”:{“消息”:{“最大长度”:"必须少于256个字符",“模式”:必须是字母数字,不包含任何空格或特殊字符},“模式”:{},“最大长度”:256},“id”:“8 f0c953df91d10b767d66e1d7d00d631”,“独一无二”:真正的,“可编辑”:真正的,“要求”:真正的,“类型”:“明文”,“鼻涕虫”:“鼻涕虫”,“名称”:“鼻涕虫”},{“默认”:假,“id”:“e4e92e700d70faffac6fa82ff2bfaece”,“可编辑”:真正的,“要求”:真正的,“类型”:“Bool”,“鼻涕虫”:“_archived”,“名称”:“存档”},{“默认”:假,“id”:“f2675b2ac4fcef746b24d4a320887ef8”,“可编辑”:真正的,“要求”:真正的,“类型”:“Bool”,“鼻涕虫”:“_draft”,“名称”:“草案”},{“id”:“0913 a35d92208bdf8fbf3ed1e39b771e”,“可编辑”:假,“要求”:假,“类型”:“日期”,“鼻涕虫”:“创建”,“名称”:“创建”},{“id”:“3 de04889465fe6d718e47b152ef5bb4d”,“可编辑”:假,“要求”:假,“类型”:“日期”,“鼻涕虫”:“更新”,“名称”:“更新”},{“id”:“2 a3cd866d5dbb294896130b233218626”,“可编辑”:假,“要求”:假,“类型”:“日期”,“鼻涕虫”:“发表”,“名称”:“发表”},{“id”:“62 c18561b9e89517751c6d8712d48f91”,“可编辑”:假,“要求”:假,“类型”:“用户”,“鼻涕虫”:“由”,“名称”:“由”},{“id”:“50918093 b4e4d4eca1e83c25bcdc06a4”,“可编辑”:假,“要求”:假,“类型”:“用户”,“鼻涕虫”:“更新”,“名称”:“更新”},{“id”:“5 c4587f18b32ef245daeaadfcba7860b”,“可编辑”:假,“要求”:假,“类型”:“用户”,“鼻涕虫”:“出版”,“名称”:“出版”}]}
场 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 集合的唯一标识符 |
lastupdate |
字符串 | 集合最后一次更新的日期 |
createdOn |
字符串 | 创建集合的日期 |
的名字 |
字符串 | 给集合的名称 |
鼻涕虫 |
字符串 | 网站URL结构中的收集片段 |
singularName |
字符串 | 集合中一个项目的名称(如集合名为Posts,则为post) |
字段 |
[场] | 集合中的字段列表 |
CollectionItem
{“_archived”:假,“_draft”:假,“颜色”:“# a98080”,“名称”:“令人兴奋的博客标题”,“post”:“< p >博客内容…< / p > ",“post-summary”:“精彩博文摘要”,“主图片”:{“文件标识”:“580 e63fe8c9a982ac9b8b749”,“url”:“https://d1otoma47x30pg.cloudfront.net/580e63fc8c9a982ac9b8b744/580e63fe8c9a982ac9b8b749_1477338110257-image20.jpg”},“鼻涕虫”:“exciting-post”,“作者”:“580 e640c8c9a982ac9b8b778”,“更新”:“2016 - 11 - 15 - t22:45:32.647z”,“更新”:“Person_5660c5338e9d3b0bee3b86aa”,“创建”:“2016 - 11 - 15 - t22:45:32.647z”,“由”:“Person_5660c5338e9d3b0bee3b86aa”,“发表”:零,“出版”:零,“_cid”:“580 e63fc8c9a982ac9b8b745”,“_id”:“582 b900cba19143b2bb8a759”}
场 | 类型 | 描述 |
---|---|---|
_archived |
布尔 | 布尔值决定是否将项目设置为存档 |
_draft |
布尔 | 布尔值决定项目是否设置为draft |
_id |
字符串 | 项目的唯一标识符 |
_cid |
字符串 | 项目所属集合的唯一标识符 |
的名字 |
字符串 | 项目的名称 |
鼻涕虫 |
字符串 | 网站中项目的URL结构。注意:条目段代码的更新将中断所有引用旧段代码的链接。 |
CollectionItemList
{“项目”:[{“_archived”:假,“_draft”:假,“颜色”:“# a98080”,“名称”:“令人兴奋的博客标题”,“post”:“< p >博客内容…< / p > ",“post-summary”:“精彩博文摘要”,“主图片”:{“文件标识”:“580 e63fe8c9a982ac9b8b749”,“url”:“https://d1otoma47x30pg.cloudfront.net/580e63fc8c9a982ac9b8b744/580e63fe8c9a982ac9b8b749_1477338110257-image20.jpg”},“鼻涕虫”:“exciting-post”,“作者”:“580 e640c8c9a982ac9b8b778”,“更新”:“2016 - 11 - 15 - t22:45:32.647z”,“更新”:“Person_5660c5338e9d3b0bee3b86aa”,“创建”:“2016 - 11 - 15 - t22:45:32.647z”,“由”:“Person_5660c5338e9d3b0bee3b86aa”,“发表”:零,“出版”:零,“_cid”:“580 e63fc8c9a982ac9b8b745”,“_id”:“582 b900cba19143b2bb8a759”}],“数”:1,“限制”:1,“抵消”:0,“总”:5}
场 | 类型 | 描述 |
---|---|---|
项目 |
[CollectionItem] | 集合中的项列表 |
数 |
数量 | 退回物品数目 |
限制 |
数量 | 请求中指定的限制 |
抵消 |
数量 | 为分页指定的偏移量 |
总计 |
数量 | 集合中项目的总数 |
PublishedItems
{“publishedItemIds”:[“62 aa37923cf7a9de1ca4469c”,“62 aa37923cf7a9de1ca44697”,“62 aa37923cf7a9de1ca44696”],“错误”:[]}
场 | 类型 | 描述 |
---|---|---|
publishedItemIds |
(字符串) | 已发布项id的数组 |
错误 |
(字符串) | 一系列的错误 |
RemovedItems
{“deletedItemIds”:[“62 aa37923cf7a9de1ca4469c”,“62 aa37923cf7a9de1ca44697”,“62 aa37923cf7a9de1ca44696”],“错误”:[]}
场 | 类型 | 描述 |
---|---|---|
deletedItemIds |
(字符串) | 已删除项目id的数组 |
错误 |
(字符串) | 一系列的错误 |
用户
{“_id”:“6287 ec36a841b25637c663df”,“createdOn”:“2022 - 05 - 20 - t13:46:12.093z”,“updatedOn”:“2022 - 05 - 20 - t13:46:12.093z”,“emailVerified”:真正的,“状态”:“验证”,“数据”:{“accept-privacy”:假,“accept-communications”:假,“电子邮件”:“Some.One@home.com”,“名称”:“一些人”}}
场 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 用户的唯一标识符 |
createdOn |
字符串 | 创建用户的时间戳 |
updatedOn |
字符串 | 更新用户的时间戳 |
invitedOn |
字符串 | 邀请用户的时间戳 |
lastLogin |
字符串 | 用户登录的时间戳 |
emailVerified |
布尔 | 显示用户是否已验证其电子邮件地址 |
状态 |
字符串 | 用户的状态 |
数据 |
对象 | 包含用户的基本信息和自定义字段的对象 |
UserList
{“用户”:[{“_id”:“6287 ec36a841b25637c663df”,“createdOn”:“2022 - 05 - 20 - t13:46:12.093z”,“updatedOn”:“2022 - 05 - 20 - t13:46:12.093z”,“emailVerified”:假,“状态”:“未经证实的”,“数据”:{“accept-privacy”:假,“accept-communications”:假,“电子邮件”:“Person.One@home.com”,“名称”:“人”}},{“_id”:“6287 ec36a841b25637c663f0”,“createdOn”:“2022 - 05 - 19 t05:32:04.581z”,“updatedOn”:“2022 - 05 - 19 t05:32:04.581z”,“emailVerified”:假,“状态”:“未经证实的”,“数据”:{“accept-privacy”:假,“accept-communications”:假,“电子邮件”:“Person.Two@home.com”,“名称”:“二人”}},{“_id”:“6287 ec36a841b25637c663d9”,“createdOn”:“2022 - 05 - 17 t03:34:06.720z”,“updatedOn”:“2022 - 05 - 17 t03:34:06.720z”,“emailVerified”:真正的,“状态”:“验证”,“数据”:{“accept-privacy”:假,“accept-communications”:假,“电子邮件”:“Person.Three@home.com”,“名称”:“三人”}},{“_id”:“6287 ec37a841b25637c6641b”,“createdOn”:“2022 - 05 - 15 - t03:46:09.748z”,“updatedOn”:“2022 - 05 - 15 - t03:46:09.748z”,“emailVerified”:假,“状态”:“未经证实的”,“数据”:{“accept-privacy”:假,“accept-communications”:假,“电子邮件”:“Person.Four@home.com”,“名称”:“四人”}},{“_id”:“6287 ec37a841b25637c66449”,“createdOn”:“2022 - 05 - 15 - t02:55:38.786z”,“updatedOn”:“2022 - 05 - 15 - t02:55:38.786z”,“emailVerified”:真正的,“状态”:“验证”,“数据”:{“accept-privacy”:假,“accept-communications”:假,“电子邮件”:“Person.Five@home.com”,“名称”:“五人”}}],“数”:5,“限制”:5,“抵消”:0,“总”:201}
场 | 类型 | 描述 |
---|---|---|
数 |
数量 | 返回的用户数量 |
限制 |
数量 | 请求中指定的限制 |
抵消 |
数量 | 为分页指定的偏移量 |
总计 |
数量 | 集合中的用户总数 |
用户 |
[用户] | 一个网站的用户列表 |
AccessGroup
{“_id”:“62 be58d404be8a6cc900c081”,“名称”:“Webflowers”,“shortId”:“乔”,“鼻涕虫”:“webflowers”,“createdOn”:“2022 - 08 - 01 - t19:41:48.349z”}
场 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 访问组的唯一标识符 |
的名字 |
字符串 | 访问组的名称 |
shortId |
字符串 | 基于名称的缩短唯一标识符,为在用户的JWT中使用而优化 |
鼻涕虫 |
字符串 | 缩短了基于名称的唯一标识符,优化了人类可读性和公共API使用 |
createdOn |
字符串 | 创建访问组的日期 |
AccessGroupList
{“accessGroups”:[{“_id”:“62 be58d404be8a6cc900c081”,“名称”:“Webflowers”,“shortId”:“乔”,“鼻涕虫”:“webflowers”,“createdOn”:“2022 - 08 - 01 - t19:41:48.349z”}],“数”:1,“限制”:10,“抵消”:0,“总”:1}
场 | 类型 | 描述 |
---|---|---|
数 |
数量 | 返回的访问组数量 |
限制 |
数量 | 请求中指定的限制 |
抵消 |
数量 | 为分页指定的偏移量 |
总计 |
数量 | 集合中访问组的总数 |
accessGroups |
[AccessGroup] | 网站访问组列表 |
Webhook
{“_id”:“582266 e0cd48de0f0e3c6d8b”,“triggerType”:“form_submission”,“triggerId”:“562 ac0395358780a1f5e6fbd”,“网站”:“562 ac0395358780a1f5e6fbd”,“createdOn”:“2016 - 11 - 08 - t23:59:28.572z”}
场 | 类型 | 描述 |
---|---|---|
_id |
字符串 | Webhook的唯一标识符 |
triggerType |
TriggerType | 的实例TriggerType对象。 |
triggerId |
字符串 | Webhook Trigger的唯一标识符 |
网站 |
字符串 | Webhook的唯一标识符 |
过滤器 |
对象 | 过滤器用于选择你想要为哪些事件触发webhook。 |
lastUsed |
字符串 | 日期触发器最后一次使用 |
createdOn |
字符串 | 创建了日期触发器 |
TriggerType
价值 | 描述 |
---|---|
form_submission |
提交表单数据的JSON有效负载 |
site_publish |
发送一个网站发布 |
ecomm_new_order |
发送一个电子商务订单 |
ecomm_order_changed |
发送一个电子商务订单 |
ecomm_inventory_changed |
发送一个电子商务库存 |
memberships_user_account_added |
已添加的用户帐户 |
memberships_user_account_updated |
更新的用户帐户 |
collection_item_created |
发送一个收集项目 |
collection_item_changed |
发送一个收集项目 |
collection_item_deleted |
发送{删除:1,itemId: String} |
collection_item_unpublished |
发送{删除:1,itemId: String} |
欧宝体育在线首页
{“可交付”:真正的,“_archived”:假,“_draft”:假,“名称”:“隐形斗篷”,“ec-欧宝体育在线首页product-type”:“ff42fee0113744f693a764e3431a9cc2”,“sku-properties”:[{“id”:“a37a7991f7ca1be0d349a805a2bddb5b”,“名称”:“颜色”,“枚举”:[{“id”:“a9506da8e70a8b087f35a4094ec34a53”,“名称”:“黑曜石黑”,“鼻涕虫”:“obsidian-black”},{“id”:“c92a465a1298c95fd1cd7f4c1c96c2ba”,“名称”:“烟灰色”,“鼻涕虫”:“smoke-grey”},{“id”:“ef9511c0b56cc11ff47c5669f65030b4”,“名称”:“森林绿”,“鼻涕虫”:“森林绿”}]}],“描述”:"一种能让穿着者隐形的斗篷",“鼻涕虫”:“cloak-of-invisibility-1”,“更新”:“2020 - 04 - 01 - t22:40:19.329z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 01 - t22:40:17.602z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“default-sku”:“5 e8518536e147040726cc416”,“_cid”:“5 dd44c493543b37d5449b3a5”,“_id”:“5 e8518516e147040726cc415”}
场 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 集合的唯一标识符 |
lastupdate |
字符串 | 集合最后一次更新的日期 |
createdOn |
字符串 | 创建集合的日期 |
的名字 |
字符串 | 给集合的名称 |
鼻涕虫 |
字符串 | 网站URL结构中的收集片段 |
singularName |
字符串 | 集合中某一项的名称(如集合名为“product”,则为“product”)欧宝体育在线首页 |
字段 |
[场] | 集合中的字段列表 |
欧宝体育在线首页ProductList
{“项目”:[{“欧宝体育在线首页产品”:{“可交付”:真正的,“_archived”:假,“_draft”:假,“名称”:“隐形斗篷”,“ec-欧宝体育在线首页product-type”:“ff42fee0113744f693a764e3431a9cc2”,“sku-properties”:[{“id”:“a37a7991f7ca1be0d349a805a2bddb5b”,“名称”:“颜色”,“枚举”:[{“id”:“a9506da8e70a8b087f35a4094ec34a53”,“名称”:“黑曜石黑”,“鼻涕虫”:“obsidian-black”},{“id”:“c92a465a1298c95fd1cd7f4c1c96c2ba”,“名称”:“烟灰色”,“鼻涕虫”:“smoke-grey”},{“id”:“ef9511c0b56cc11ff47c5669f65030b4”,“名称”:“森林绿”,“鼻涕虫”:“森林绿”}]}],“描述”:"一种能让穿着者隐形的斗篷",“鼻涕虫”:“cloak-of-invisibility-1”,“更新”:“2020 - 04 - 01 - t22:40:19.329z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 01 - t22:40:17.602z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“default-sku”:“5 e8518536e147040726cc416”,“_cid”:“5 dd44c493543b37d5449b3a5”,“_id”:“5 e8518516e147040726cc415”},“sku”:[{“价格”:{“单元”:“美元”,“价值”:120000},“_archived”:假,“_draft”:假,“sku-values”:{},“宽度”:56,“长度”:0.3,“高度”:72,“重量”:24,“名称”:隐形斗篷颜色:黑曜石黑,“主图片”:{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零},“更多的图片”:[{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零},{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零}],“下载文件”:[{“id”:“5 ebb1676c3244c2c6ae18814”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“https://dropbox.com/files/modern-web-design-process.pdf”}],“鼻涕虫”:“cloak-of-invisibility-color-obsidian-black-7”,“欧宝体育在线首页产品”:“5 e8518516e147040726cc415”,“更新”:“2020 - 04 - 01 - t22:40:19.287z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 01 - t22:40:19.287z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“_cid”:“5 dd44c493543b37d5449b383”,“_id”:“5 e8518536e147040726cc416”}]}],“数”:1,“限制”:One hundred.,“抵消”:0,“总”:12}
场 | 类型 | 描述 |
---|---|---|
项目 |
[欧宝体育在线首页] | 集合内的项目对象列表。包含产品和skus欧宝体育在线首页密钥 |
数 |
数量 | 退回物品数目 |
限制 |
数量 | 请求中指定的限制 |
抵消 |
数量 | 为分页指定的偏移量 |
总计 |
数量 | 集合中项目的总数 |
欧宝体育在线首页ProductSKU
{“欧宝体育在线首页产品”:{“可交付”:真正的,“_archived”:假,“_draft”:假,“名称”:“隐形斗篷”,“ec-欧宝体育在线首页product-type”:“ff42fee0113744f693a764e3431a9cc2”,“sku-properties”:[{“id”:“a37a7991f7ca1be0d349a805a2bddb5b”,“名称”:“颜色”,“枚举”:[{“id”:“a9506da8e70a8b087f35a4094ec34a53”,“名称”:“黑曜石黑”,“鼻涕虫”:“obsidian-black”},{“id”:“c92a465a1298c95fd1cd7f4c1c96c2ba”,“名称”:“烟灰色”,“鼻涕虫”:“smoke-grey”},{“id”:“ef9511c0b56cc11ff47c5669f65030b4”,“名称”:“森林绿”,“鼻涕虫”:“森林绿”}]}],“描述”:"一种能让穿着者隐形的斗篷",“鼻涕虫”:“cloak-of-invisibility-1”,“更新”:“2020 - 04 - 01 - t22:40:19.329z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 01 - t22:40:17.602z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“default-sku”:“5 e8518536e147040726cc416”,“_cid”:“5 dd44c493543b37d5449b3a5”,“_id”:“5 e8518516e147040726cc415”},“sku”:{“价格”:{“单元”:“美元”,“价值”:120000},“_archived”:假,“_draft”:假,“sku-values”:{},“宽度”:56,“长度”:0.3,“高度”:72,“重量”:24,“名称”:隐形斗篷颜色:黑曜石黑,“主图片”:{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零},“更多的图片”:[{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零},{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零}],“下载文件”:[{“id”:“5 ebb1676c3244c2c6ae18814”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“https://dropbox.com/files/modern-web-design-process.pdf”}],“鼻涕虫”:“cloak-of-invisibility-color-obsidian-black-7”,“欧宝体育在线首页产品”:“5 e8518516e147040726cc415”,“更新”:“2020 - 04 - 01 - t22:40:19.287z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 01 - t22:40:19.287z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“_cid”:“5 dd44c493543b37d5449b383”,“_id”:“5 e8518536e147040726cc416”}}
场 | 类型 | 描述 |
---|---|---|
欧宝体育在线首页 |
欧宝体育在线首页 | 的实例欧宝体育在线首页对象。 |
sku |
SKU | 的实例SKU对象。 |
欧宝体育在线首页ProductSKUList
{“项目”:[{“欧宝体育在线首页产品”:{“可交付”:真正的,“_archived”:假,“_draft”:假,“名称”:“隐形斗篷”,“ec-欧宝体育在线首页product-type”:“ff42fee0113744f693a764e3431a9cc2”,“sku-properties”:[{“id”:“a37a7991f7ca1be0d349a805a2bddb5b”,“名称”:“颜色”,“枚举”:[{“id”:“a9506da8e70a8b087f35a4094ec34a53”,“名称”:“黑曜石黑”,“鼻涕虫”:“obsidian-black”},{“id”:“c92a465a1298c95fd1cd7f4c1c96c2ba”,“名称”:“烟灰色”,“鼻涕虫”:“smoke-grey”},{“id”:“ef9511c0b56cc11ff47c5669f65030b4”,“名称”:“森林绿”,“鼻涕虫”:“森林绿”}]}],“描述”:"一种能让穿着者隐形的斗篷",“鼻涕虫”:“cloak-of-invisibility-1”,“更新”:“2020 - 04 - 01 - t22:40:19.329z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 01 - t22:40:17.602z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“default-sku”:“5 e8518536e147040726cc416”,“_cid”:“5 dd44c493543b37d5449b3a5”,“_id”:“5 e8518516e147040726cc415”},“sku”:[{“价格”:{“单元”:“美元”,“价值”:120000},“_archived”:假,“_draft”:假,“sku-values”:{},“宽度”:56,“长度”:0.3,“高度”:72,“重量”:24,“名称”:隐形斗篷颜色:黑曜石黑,“主图片”:{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零},“更多的图片”:[{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零},{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零}],“下载文件”:[{“id”:“5 ebb1676c3244c2c6ae18814”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“https://dropbox.com/files/modern-web-design-process.pdf”}],“鼻涕虫”:“cloak-of-invisibility-color-obsidian-black-7”,“欧宝体育在线首页产品”:“5 e8518516e147040726cc415”,“更新”:“2020 - 04 - 01 - t22:40:19.287z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 01 - t22:40:19.287z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“_cid”:“5 dd44c493543b37d5449b383”,“_id”:“5 e8518536e147040726cc416”}]}],“数”:1,“限制”:One hundred.,“抵消”:0,“总”:12}
场 | 类型 | 描述 |
---|---|---|
项目 |
[欧宝体育在线首页] | 产品的sku列表欧宝体育在线首页 |
数 |
数量 | 退回物品数目 |
限制 |
数量 | 请求中指定的限制 |
抵消 |
数量 | 为分页指定的偏移量 |
总计 |
数量 | 集合中项目的总数 |
SKU
{“价格”:{“单元”:“美元”,“价值”:120000},“_archived”:假,“_draft”:假,“sku-values”:{},“宽度”:56,“长度”:0.3,“高度”:72,“重量”:24,“名称”:隐形斗篷颜色:黑曜石黑,“主图片”:{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零},“更多的图片”:[{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零},{“文件标识”:“5 e85161dabd9ea4072cf1414”,“url”:“https://d1otoma47x30pg.cloudfront.net/5d93ba5e38c6b0160ab711d6/5e85161dabd9ea4072cf1414_5e8512181ae993035b15f315_external-content.duckduckgo.com.jpeg”,“alt”:零}],“下载文件”:[{“id”:“5 ebb1676c3244c2c6ae18814”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“https://dropbox.com/files/modern-web-design-process.pdf”}],“鼻涕虫”:“cloak-of-invisibility-color-obsidian-black-7”,“欧宝体育在线首页产品”:“5 e8518516e147040726cc415”,“更新”:“2020 - 04 - 01 - t22:40:19.287z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 01 - t22:40:19.287z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“_cid”:“5 dd44c493543b37d5449b383”,“_id”:“5 e8518536e147040726cc416”}
场 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 集合的唯一标识符 |
lastupdate |
字符串 | 集合最后一次更新的日期 |
createdOn |
字符串 | 创建集合的日期 |
的名字 |
字符串 | 给集合的名称 |
鼻涕虫 |
字符串 | 网站URL结构中的收集片段 |
singularName |
字符串 | 集合中某一项的名称(如集合名为“sku”,则为“sku”) |
字段 |
[场] | 集合中的字段列表 |
SKUList
{“sku”:[{“鼻涕虫”:“cloak-of-invisibility-color-smoke-grey”,“_archived”:假,“_draft”:假,“价格”:{“单元”:“美元”,“价值”:120000},“更多的图片”:[],“下载文件”:[{“id”:“5 ebb1945c3244c2c6ae18822”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“https://dropbox.com/files/modern-web-design-process.pdf”}],“sku-values”:{“a37a7991f7ca1be0d349a805a2bddb5b”:“c92a465a1298c95fd1cd7f4c1c96c2ba”},“宽度”:56,“长度”:0.3,“高度”:72,“重量”:24,“名称”:隐形斗篷颜色:烟灰色,“主图片”:{“文件标识”:“5 e8512181ae993035b15f315”,“文件”:{“_id”:“5 e8512181ae993035b15f315”,“变异”:[{“_id”:“5 e85121b1ae993035b15f316”,“origFileName”:“外部——content.duckduckgo.com——p - 500. - jpeg ",“文件名”:“5 e8512181ae993035b15f315_external——content.duckduckgo.com——p - 500. - jpeg ",“格式”:“jpeg”,“大小”:54068,“宽度”:500,“质量”:One hundred.,“s3Url”:“https://s3.amazonaws.com/webflow - dev - assets/5e8402eb8a402e354bd469bb/5e8512181ae993035b15f315_external content.duckduckgo.com——p - 500. - jpeg "}],“origFileName”:“invisibility_cloak.jpg”,“文件名”:“5 e8512181ae993035b15f315_external-content.duckduckgo.com.jpg”,“fileHash”:“860 b1b99ce90aa6c175bfcd9fd59fd42”,“s3Url”:“https://s3.amazonaws.com/webflow-dev-assets/5e8402eb8a402e354bd469bb/5e8512181ae993035b15f315_external-content.duckduckgo.com.jpg”,“mimeType”:“图像/ jpeg”,“大小”:192263,“宽度”:550,“高度”:550,“数据库”:“5 e8402eb8a402e354bd469bb”,“createdOn”:“2020 - 04 - 01 - t22:13:44.889z”,“__v”:1,“updatedOn”:“2020 - 04 - 01 - t22:13:59.777z”},“文件大小”:192263,“url”:“https://d1otoma47x30pg.cloudfront.net/5e8402eb8a402e354bd469bb/5e8512181ae993035b15f315_external-content.duckduckgo.com.jpg”,“alt”:零},“欧宝体育在线首页产品”:“5 e8518516e147040726cc415”,“更新”:“2020 - 04 - 03 - t18:50:45.947z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 03 - t18:50:45.947z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“_cid”:“5 e8402eb8a402e354bd469be”,“_id”:“5 e8785855617d73f34627a93”},{“_archived”:假,“_draft”:假,“价格”:{“单元”:“美元”,“价值”:120000},“更多的图片”:[],“下载文件”:[{“id”:“5 ebb1945c3244c2c6ae18823”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“https://dropbox.com/files/modern-web-design-process.pdf”}],“sku-values”:{“a37a7991f7ca1be0d349a805a2bddb5b”:“ef9511c0b56cc11ff47c5669f65030b4”},“宽度”:56,“长度”:0.3,“高度”:72,“重量”:24,“名称”:隐形斗篷颜色:森林绿,“主图片”:{“文件标识”:“5 e8512181ae993035b15f315”,“文件”:{“_id”:“5 e8512181ae993035b15f315”,“变异”:[{“_id”:“5 e85121b1ae993035b15f316”,“origFileName”:“外部——content.duckduckgo.com——p - 500. - jpeg ",“文件名”:“5 e8512181ae993035b15f315_external——content.duckduckgo.com——p - 500. - jpeg ",“格式”:“jpeg”,“大小”:54068,“宽度”:500,“质量”:One hundred.,“s3Url”:“https://s3.amazonaws.com/webflow - dev - assets/5e8402eb8a402e354bd469bb/5e8512181ae993035b15f315_external content.duckduckgo.com——p - 500. - jpeg "}],“origFileName”:“invisibility_cloak.jpg”,“文件名”:“5 e8512181ae993035b15f315_external-content.duckduckgo.com.jpg”,“fileHash”:“860 b1b99ce90aa6c175bfcd9fd59fd42”,“s3Url”:“https://s3.amazonaws.com/webflow-dev-assets/5e8402eb8a402e354bd469bb/5e8512181ae993035b15f315_external-content.duckduckgo.com.jpg”,“mimeType”:“图像/ jpeg”,“大小”:192263,“宽度”:550,“高度”:550,“数据库”:“5 e8402eb8a402e354bd469bb”,“createdOn”:“2020 - 04 - 01 - t22:13:44.889z”,“__v”:1,“updatedOn”:“2020 - 04 - 01 - t22:13:59.777z”},“文件大小”:192263,“url”:“https://d1otoma47x30pg.cloudfront.net/5e8402eb8a402e354bd469bb/5e8512181ae993035b15f315_external-content.duckduckgo.com.jpg”,“alt”:零},“鼻涕虫”:“cloak-of-invisibility-color-forest-green”,“欧宝体育在线首页产品”:“5 e8518516e147040726cc415”,“更新”:“2020 - 04 - 03 - t18:50:45.949z”,“更新”:“Person_5d8fcb6d94dd1853060fb3b3”,“创建”:“2020 - 04 - 03 - t18:50:45.949z”,“由”:“Person_5d8fcb6d94dd1853060fb3b3”,“发表”:零,“出版”:零,“_cid”:“5 e8402eb8a402e354bd469be”,“_id”:“5 e8785855617d73f34627a94”}]}
场 | 类型 | 描述 |
---|---|---|
sku |
[SKU] |
场
{“名称”:“令人兴奋的博客标题”,“鼻涕虫”:“exciting-post”,“_archived”:假,“_draft”:假,“颜色”:“# a98080”,“作者”:“580 e640c8c9a982ac9b8b778”,“post”:“< p >博客内容…< / p > ",“post-summary”:“精彩博文摘要”,“主图片”:“580 e63fe8c9a982ac9b8b749”}
场 | 类型 | 描述 |
---|---|---|
id |
字符串 | 字段的唯一标识符 |
鼻涕虫 |
字符串 | 网站的URL结构中用于模板页面的字段的段塞 |
的名字 |
字符串 | 字段的名称 |
类型 |
FieldType | 的实例FieldType对象。 |
可编辑的 |
布尔 | 确定字段是否可编辑(有些字段是自动创建的,不能编辑) |
要求 |
布尔 | 确定是否需要该字段 |
验证 |
验证 | 的实例验证对象。 |
InnerFieldType
内部字段类型遵循与字段类型相同的规则,但用于描述“Set”字段Array元素的类型。它们可能在设计器和编辑器中使用稍微不同的名称,并在这里列出一个“alt名称”,这是我们公开显示的字段的名称。(但是对于API,我们只使用字段类型的实际名称)。
价值 | 描述 |
---|---|
ExtFileRef |
包含name(字符串)和URL(字符串)属性的对象 |
ImageRef |
CMS中图像的唯一id |
FieldType
价值 | 描述 |
---|---|
保龄球 |
Yes/no开关用于过滤站点中显示的数据,例如:特色 |
颜色 |
CSS颜色值(即:“红色” 或“# e3e3e3” ) |
日期 |
日期字段,用于显示月、日、年和时间的任何组合 |
ExtFileRef |
包含name(字符串)和URL(字符串)属性的对象 |
集 |
字段包含外部文件的多个对象 |
ImageRef |
CMS中图像的唯一id |
集 |
包含CMS中图像的多个唯一id的字段 |
ItemRef |
包含从另一个集合引用的项的字段 |
ItemRefSet |
包含从另一个集合引用的多个项的字段 |
链接 |
URL字段,其中的值可以用作按钮、链接文本和链接块的链接目的地 |
数量 |
单行输入字段仅用于数字 |
选项 |
有多个选项的下拉框 |
明文 |
未格式化的文本(没有图像、样式等) |
RichText |
格式化文本(带有标题、超链接、图像等) |
视频 |
视频链接字段,用于嵌入来自YouTube和Vimeo的视频 |
验证
{“单行模式”:假,“最大长度”:256,“消息”:{“最大长度”:"必须少于256个字符",“模式”:必须是字母数字,不包含任何空格或特殊字符},“模式”:{}}
场 | 类型 | 描述 |
---|---|---|
最大长度 |
数量 | |
最小长度 |
数量 | |
最低 |
数量 | |
最大 |
数量 | |
最大尺寸 |
数量 | |
decimalPlaces |
数量 | |
单行模式 |
布尔 | |
选项 |
(字符串) | |
格式 |
字符串 | |
精度 |
数量 | |
allowNegative |
布尔 | |
collectionId |
字符串 |
CategoryCollection
{“_id”:“5 e8402eb8a402e354bd469bc”,“名称”:“类别”,“鼻涕虫”:“类别”,“singularName”:“类别”,“createdOn”:“2020 - 04 - 01 - t02:56:43.638z”,“lastupdate”:“2020 - 04 - 01 - t02:56:43.690z”,“字段”:[{“id”:“a624247e3528136a36a8b1c5dbdc2632”,“名称”:“名称”,“鼻涕虫”:“名称”,“类型”:“明文”,“要求”:真正的,“可编辑”:真正的,“验证”:{“最大长度”:256}},{“id”:“7 c3fbdf76e7f2d6e894878fce6373e4e”,“名称”:“鼻涕虫”,“鼻涕虫”:“鼻涕虫”,“类型”:“明文”,“要求”:真正的,“可编辑”:真正的,“独一无二”:真正的,“验证”:{“最大长度”:256,“模式”:{},“消息”:{“模式”:必须是字母数字,不包含任何空格或特殊字符,“最大长度”:"必须少于256个字符"}}},{“id”:“924 a90e06131260ec1b4cde3fe04c78b”,“名称”:“存档”,“鼻涕虫”:“_archived”,“类型”:“Bool”,“要求”:真正的,“可编辑”:真正的,“默认”:假},{“id”:“e0de891b154790b2b5a7887c96e69673”,“名称”:“草案”,“鼻涕虫”:“_draft”,“类型”:“Bool”,“要求”:真正的,“可编辑”:真正的,“默认”:假},{“id”:“d005eb440992807385b5527d7ac3df43”,“名称”:“创建”,“鼻涕虫”:“创建”,“类型”:“日期”,“要求”:假,“可编辑”:假},{“id”:“885952 f7145ef136f1e33ee5718a203d”,“名称”:“更新”,“鼻涕虫”:“更新”,“类型”:“日期”,“要求”:假,“可编辑”:假},{“id”:“54 fb5afe9258d9d7eb4e7d105ad4ecf4”,“名称”:“发表”,“鼻涕虫”:“发表”,“类型”:“日期”,“要求”:假,“可编辑”:假},{“id”:“42426 a9a2fae38908c0f24785fd947ee”,“名称”:“由”,“鼻涕虫”:“由”,“类型”:“用户”,“要求”:假,“可编辑”:假},{“id”:“cb36015872421ae965b88d77ce3bbdaa”,“名称”:“更新”,“鼻涕虫”:“更新”,“类型”:“用户”,“要求”:假,“可编辑”:假},{“id”:“a2741c16493270db634b2b6122dd8ebe”,“名称”:“出版”,“鼻涕虫”:“出版”,“类型”:“用户”,“要求”:假,“可编辑”:假}]}
场 | 类型 | 描述 |
---|---|---|
_id |
字符串 | 集合的唯一标识符 |
lastupdate |
字符串 | 集合最后一次更新的日期 |
createdOn |
字符串 | 创建集合的日期 |
的名字 |
字符串 | 给集合的名称 |
鼻涕虫 |
字符串 | 网站URL结构中的收集片段 |
singularName |
字符串 | 集合中一个项目的名称(如集合名为“类别”,则为“类别”) |
字段 |
[场] | 集合中的字段列表 |
StripeDetails
{“refundReason”:零,“refundId”:零,“disputeId”:零,“chargeId”:“ch_1DdPYQKMjGA7k9mI2AKiBY6u”,“customerId”:“cus_E5ajeiWNHEtcAW”}
场 | 类型 | 描述 |
---|---|---|
refundReason |
字符串 | 条带客户ID,或null。 |
refundId |
字符串 | 条纹电荷ID,或null。 |
disputeId |
字符串 | 条带争议ID,或null。 |
chargeId |
字符串 | 条纹退款ID,或null。 |
customerId |
字符串 |
StripeCard
{“last4”:“4242”,“品牌”:“签证”,“ownerName”:“Customerio以”,“过期”:{“年”:2023,“月”:12}}
场 | 类型 | 描述 |
---|---|---|
last4 |
字符串 | 卡上的最后4位数字。 |
品牌 |
字符串 | 名片的品牌。 |
ownerName |
字符串 | 名片上的名字。 |
到期 |
对象 | 这张卡的有效期。 |
OrderAmount
5892
场 | 类型 | 描述 |
---|---|---|
单位 |
字符串 | |
价值 |
字符串 | |
字符串 |
字符串 |
OrderAddress
{“类型”:“账单”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”}
场 | 类型 | 描述 |
---|---|---|
类型 |
字符串 | |
收件人 |
字符串 | |
line1 |
字符串 | |
么 |
字符串 | |
城市 |
字符串 | |
状态 |
字符串 | |
国家 |
字符串 | |
postalCode |
字符串 |
OrderCustomerInfo
{“fullName”:“Customerio以”,“电子邮件”:“任+ customer@www.raktarban.com”}
场 | 类型 | 描述 |
---|---|---|
fullName |
字符串 | |
电子邮件 |
字符串 |
OrderDownloadedFile
{“id”:“5 e9a5eba75e0ac242e1b6f64”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“//www.raktarban.com/dashboard/download-digital-欧宝体育在线首页product?payload=5d93ba5e38c6b0160ab711d3; e7634a; 5 eb1aac72912ec06f561278c; 5 e9a5eba75e0ac242e1b6f63: ka2nehxy: 4 a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa”}
场 | 类型 | 描述 |
---|---|---|
id |
字符串 | |
的名字 |
字符串 | |
url |
字符串 |
OrderItemImage
{“文件标识”:“5 bfedb42bab0ad90fa7dad2e”,“url”:“https://d1otoma47x30pg.cloudfront.net/5bfedb42bab0ad90fa7dac03/5bfedb42bab0ad90fa7dad2e_5bb3d019b3465c6e8a324dd7_458036-unsplas.png”}
场 | 类型 | 描述 |
---|---|---|
文件标识 |
字符串 | |
url |
字符串 |
OrderPurchasedItem
{“数”:1,“rowTotal”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“欧宝体育在线首页productId”:“5 eb9fd05caef491eb9757183”,“欧宝体育在线首页productName”:“白杯”,“欧宝体育在线首页productSlug”:“白色杯子”,“variantId”:“5 eb9fcace279761d8199790c”,“variantName”:“white-cup_default_sku”,“variantSlug”:“white-cup-default-sku”,“variantImage”:{“文件标识”:“5 bfedb42bab0ad90fa7dad2e”,“url”:“https://d1otoma47x30pg.cloudfront.net/5bfedb42bab0ad90fa7dac03/5bfedb42bab0ad90fa7dad2e_5bb3d019b3465c6e8a324dd7_458036-unsplas.png”},“variantPrice”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“高度”:7,“长度”:2,“重量”:5,“宽度”:4}
场 | 类型 | 描述 |
---|---|---|
数 |
数量 | 购买的物品数量。 |
rowTotal |
OrderAmount | 的实例OrderAmount对象。 |
欧宝体育在线首页productId |
字符串 | 产品Id字符串欧宝体育在线首页。 |
欧宝体育在线首页productName |
字符串 | 产品名称。欧宝体育在线首页 |
欧宝体育在线首页productSlug |
字符串 | 产品的鼻涕虫。欧宝体育在线首页 |
variantId |
字符串 | Id字符串变体。(SKU) |
variantName |
字符串 | 变体的名称。(SKU) |
variantSlug |
字符串 | 变种的弹头。(SKU) |
variantImage |
OrderItemImage | 的实例OrderItemImage对象。 |
variantPrice |
OrderAmount | 的实例OrderAmount对象。 |
高度 |
数量 | 如果提供了变量的高度,则为0。 |
长度 |
数量 | 如果提供了变量的长度,则为0。 |
宽度 |
数量 | 如果提供了变量的宽度,则为0 |
重量 |
数量 | 如果提供了变量的权值,则为0。 |
purchasedItemsCount |
数量 | “purchasedItems”中所有“count”字段的总和。 |
OrderExtra
{“类型”:“税”,“名称”:“国家税收”,“描述”:”“CA税(6.25%),“价格”:{“单元”:“美元”,“价值”:344,“字符串”:“3.44”}}
场 | 类型 | 描述 |
---|---|---|
类型 |
字符串 | 这是额外项目的类型。 |
的名字 |
字符串 | 为这笔额外费用取一个人类可读(但英文)的名字。 |
描述 |
字符串 | 对这一额外费用的一种人类可读(但英文)的描述。 |
价格 |
OrderAmount | 的实例OrderAmount对象。 |
OrderTotals
{“小计”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”}}
场 | 类型 | 描述 |
---|---|---|
小计 |
OrderAmount | 的实例OrderAmount对象。 |
临时演员 |
[OrderExtra] | 一系列额外的项目,包括折扣,运费和税。 |
总计 |
OrderAmount | 的实例OrderAmount对象。 |
订单
{“orderId”:“dfa-3f1”,“状态”:“未实现”,“评论”:"",“orderComment”:"",“acceptedOn”:“2018 - 12 - 03 - t22:06:15.761z”,“disputedOn”:零,“disputeUpdatedOn”:零,“disputeLastStatus”:零,“fulfilledOn”:零,“refundedOn”:零,“customerPaid”:{“单元”:“美元”,“价值”:6099,“字符串”:“60.99”},“netAmount”:{“单元”:“美元”,“价值”:5892,“字符串”:“58.92”},“requiresShipping”:真正的,“shippingProvider”:零,“shippingTracking”:零,“customerInfo”:{“fullName”:“Customerio以”,“电子邮件”:“任+ customer@www.raktarban.com”},“allAddresses”:[{“类型”:“账单”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},{“类型”:“运输”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”}],“shippingAddress”:{“类型”:“运输”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},“billingAddress”:{“类型”:“账单”,“收件人”:“Customerio以”,“line1”:“123路”,“么”:"",“城市”:“Examplesville”,“状态”:“CA”,“国家”:“我们”,“邮政编码”:“90012”},“purchasedItems”:[{“数”:1,“rowTotal”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“欧宝体育在线首页productId”:“5 eb9fd05caef491eb9757183”,“欧宝体育在线首页productName”:“白杯”,“欧宝体育在线首页productSlug”:“白色杯子”,“variantId”:“5 eb9fcace279761d8199790c”,“variantName”:“white-cup_default_sku”,“variantSlug”:“white-cup-default-sku”,“variantImage”:{“文件标识”:“5 bfedb42bab0ad90fa7dad2e”,“url”:“https://d1otoma47x30pg.cloudfront.net/5bfedb42bab0ad90fa7dac03/5bfedb42bab0ad90fa7dad2e_5bb3d019b3465c6e8a324dd7_458036-unsplas.png”},“variantPrice”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“高度”:7,“长度”:2,“重量”:5,“宽度”:4}],“purchasedItemsCount”:1,“stripeDetails”:{“refundReason”:零,“refundId”:零,“disputeId”:零,“chargeId”:“ch_1DdPYQKMjGA7k9mI2AKiBY6u”,“customerId”:“cus_E5ajeiWNHEtcAW”},“stripeCard”:{“last4”:“4242”,“品牌”:“签证”,“ownerName”:“Customerio以”,“过期”:{“年”:2023,“月”:12}},“总数”:{“小计”:{“单元”:“美元”,“价值”:5500,“字符串”:“55.00”},“临时演员”:[{“类型”:“税”,“名称”:“国家税收”,“描述”:”“CA税(6.25%),“价格”:{“单元”:“美元”,“价值”:344,“字符串”:“3.44”}},{“类型”:“税”,“名称”:“县税”,“描述”:洛杉矶税(1.00%),“价格”:{“单元”:“美元”,“价值”:55,“字符串”:“0.55”}},{“类型”:“税”,“名称”:“特别区税”,“描述”:特别地区税(2.25%),“价格”:{“单元”:“美元”,“价值”:124,“字符串”:“1.24”}},{“类型”:“运输”,“名称”:“平率”,“描述”:"",“价格”:{“单元”:“美元”,“价值”:599,“字符串”:“5.99”}},{“类型”:“折扣”,“名称”:“折扣(SAVE5)”,“描述”:"",“价格”:{“单元”:“美元”,“价值”:-500年,“字符串”:”——5.00美元”}}],“总”:{“单元”:“美元”,“价值”:6122,“字符串”:“61.22”}},“customData”:[{“textInput”:“(415)123 - 4567”,“名称”:“电话”},{“文本区域”:“妈妈生日快乐!”,“名称”:“礼物注意”},{“复选框”:真正的,“名称”:“送礼物”}],“downloadFiles”:[{“id”:“5 e9a5eba75e0ac242e1b6f64”,“名称”:现代网页设计过程- Webflow电子书。pdf,“url”:“//www.raktarban.com/dashboard/download-digital-欧宝体育在线首页product?payload=5d93ba5e38c6b0160ab711d3; e7634a; 5 eb1aac72912ec06f561278c; 5 e9a5eba75e0ac242e1b6f63: ka2nehxy: 4 a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa”},{“id”:“5 e9a5eba75e0ac242e1b6f63”,“名称”:自由网页设计师指南- Webflow电子书。pdf,“url”:“//www.raktarban.com/dashboard/download-digital-欧宝体育在线首页product?payload=5d93ba5e38c6b0160ab711d3; e7634a; 5 dd44c493543b37d5449b3cd; 5 e9a5eba75e0ac242e1b6f63: ka2nehxy: 6 af5adf7c6fff7a3b0f54404fac1be492ac6f1ed5340416f1fe27c5fd4dd8079”}]}
场 | 类型 | 描述 |
---|---|---|
orderId |
字符串 | 订单id。通常是6个十六进制字符,但如果网站有大量的订单,也可以是9个十六进制字符。随机分配。 |
状态 |
字符串 | 之一等待 ,未实现的 ,实现了 ,有争议的 ,dispute-lost ,或退还 |
评论 |
字符串 | 此订单的注释字符串,可由API用户编辑(Webflow不使用)。 |
orderComment |
字符串 | 顾客在下单时留下的注释 |
acceptedOn |
字符串 | 下单的ISO8601时间戳。 |
disputedOn |
字符串 | 如果客户对订单有争议,那么该密钥将设置为ISO8601时间戳,Stripe将通知Webflow。如果没有争议,则为空。 |
disputeUpdatedOn |
字符串 | 如果客户对订单有争议,那么这个密钥将使用我们最后一次获得更新的ISO8601时间戳设置。如果没有争议,则为空。 |
disputeLastStatus |
字符串 | 如果客户对订单有异议,则将设置此键 |
与争议的地位. | ||
fulfilledOn |
字符串 | 如果订单被标记为“已完成”,那么这是发生时的ISO8601时间戳。 |
refundedOn |
字符串 | 如果订单被退款,这是发生时间的ISO8601。 |
customerPaid |
OrderAmount | 的实例OrderAmount对象。 |
netAmount |
OrderAmount | 的实例OrderAmount对象。 |
requiresShipping |
布尔 | 一个布尔值,指示订单是否包含一个或多个需要运输的已购买项目。 |
shippingProvider |
字符串 | API用户可编辑的字符串,以说明使用的运输提供程序(Webflow不使用)。 |
shippingTracking |
字符串 | API用户可编辑的字符串,用于记录订单的发货跟踪编号(Webflow不使用)。 |
customerInfo |
OrderCustomerInfo | 的实例OrderCustomerInfo对象。 |
allAddresses |
[OrderAddress] | 客户在订购流程中提供的所有地址。 |
shippingAddress |
OrderAddress | 的实例OrderAddress对象。 |
billingAddress |
OrderAddress | 的实例OrderAddress对象。 |
purchasedItems |
[OrderPurchasedItem] | 顾客购买的所有东西的数组。 |
stripeDetails |
StripeDetails | 的实例StripeDetails对象。 |
stripeCard |
StripeCard | 的实例StripeCard对象。 |
总数 |
OrderTotals | 的实例OrderTotals对象。 |
customData |
(对象) | 用于自定义订单数据收集的附加输入数组。数组中的每个对象都表示一个具有名称和texttinput、textArea或复选框值的输入。 |
downloadFiles |
[OrderDownloadedFile] | 可下载文件对象的数组。 |
ItemInventory
{“_id”:“5 bfedb42bab0ad90fa7dad39”,“数量”:83,“inventoryType”:“有限”}
场 | 类型 | 描述 |
---|---|---|
_id |
字符串 | SKU项的唯一标识符 |
数量 |
数量 | 存货中剩余物品的总数(如果有限) |
inventoryType |
字符串 | 无限和有限 |
EcommerceSettings
{“createdOn”:“2019 - 02 - 21 - t18:41:47.312z”,“网站”:“62 f3b1f7eafbc45d0c64ef93”,“defaultCurrency”:“美元”}
场 | 类型 | 描述 |
---|---|---|
createdOn |
字符串 | 网站创建的日期 |
网站 |
字符串 | 需要查询的站点id |
defaultCurrency |
字符串 | 网站的三字母货币代码 |
SitePublish
{“网站”:“62749158 efef318abc8d5a0f”,“publishTime”:1653619272801,“域”:[“my-website.webflow.io”],“publishedBy”:{“名称”:“一些人”,“id”:“123460 a7b6c16def4527122d”}}
场 | 类型 | 描述 |
---|---|---|
网站 |
字符串 | 发布的站点id |
publishTime |
字符串 | 发布事件的时间戳 |
域 |
(字符串) | 已发布的域 |
publishedBy |
对象 | 发布站点的用户的名称和id |
错误
{“味精”:“不能访问资源”,“代码”:401,“名称”:“未经授权的”,“路径”:“/网站/ invalid_site”,“呃”:"未经授权:无法访问资源"}
场 | 类型 | 描述 |
---|---|---|
代码 |
数量 | HTTP错误代码 |
味精 |
字符串 | 错误消息 |
的名字 |
字符串 | 错误的名称 |
路径 |
字符串 | 导致错误的请求路径 |
犯错 |
字符串 | 完整的错误字符串 |
问题 |
(字符串) | 错误数组(通常在ValidationErrors上) |
DeleteResult
{“删除”:1}
场 | 类型 | 描述 |
---|---|---|
删除 |
数量 | 删除的记录数量 |