后台刻录程序API参考

背景燃烧器 API使您可以将Bonanza的Background Burner功能集成到您自己的应用程序或网站中。 试用背景刻录机 为自己。

为了使用API​​,您必须具备 Bonanza API凭证.

所有Background Burner API请求都返回一个 JSON回应.

该API提供了四个RESTful操作:

  • 创建:排队进行新的后台刻录
  • 显示:获取特定背景刻录的进度
  • 更新:为特定的背景刻录选择“最终蒙版”
  • 删除:删除特定的背景烧伤
  • 索引:列出特定用户的最近100次烧伤

创造

排队进行新的后台刻录。

提交到URL: //api.sanyili.com/api/background_burns
方法: 开机自检

请求参数

论据 类型 发生 含义
网址 网址 需要 远程URL到要刻录的图像
需要 您的Bonanza API开发人员ID
用户身份 推荐的 用户标识符 分配给用户。通常,它是您的应用程序分配给用户的唯一ID。我们将为重复刻录相同类型图像的用户优化刻录性能。
名称 可选的 文件名或图片标题。有关图片的信息越多,我们刻录它的速度越快。
描述 可选的 描述图片的任何其他文本。
打回来 网址 可选的 刻录完成以及选择或更改最终蒙版时,我们应该发布到的URL。
它必须是包含协议的有效URL(“ http://”或“ http:// _”)。

显示

获取特定背景刻录的进度。

提交到URL: //api.sanyili.com/api/background_burns/:id
方法: 得到
:ID 您要查看的背景刻录的唯一ID

请求参数

论据 类型 发生 含义
需要 您的Bonanza API开发人员ID
用户身份 需要 用户标识符 在排队背景烧录时分配给用户。通常,它是您的应用程序分配给用户的唯一ID。我们将为重复刻录相同类型图像的用户优化刻录性能。

更新资料

为特定的背景刻录选择“最终蒙版”。

提交到URL: //api.sanyili.com/api/background_burns/:id
方法:
:ID 您要查看的背景刻录的唯一ID

请求参数

论据 类型 发生 含义
需要 您的Bonanza API开发人员ID
用户身份 需要 用户标识符 在排队背景烧录时分配给用户。通常,它是您的应用程序分配给用户的唯一ID。我们将为重复刻录相同类型图像的用户优化刻录性能。
selected_mask_id 整数 需要 应用于此背景刻录的“最终蒙版”的背景蒙版ID

删除

清除特定的背景烧伤。一旦删除,它将不再显示在索引响应中。

提交到URL: //api.sanyili.com/api/background_burns/:id
方法: 删除
:ID 您要删除的背景刻录的唯一ID

请求参数

论据 类型 发生 含义
需要 您的Bonanza API开发人员ID
用户身份 需要 用户标识符  在排队背景烧录时分配给用户。通常,它是您的应用程序分配给用户的唯一ID。我们将为重复刻录相同类型图像的用户优化刻录性能。

指数

列出特定用户的最近100次烧伤。

提交到URL: //api.sanyili.com/api/background_burns
方法: 得到

请求参数

论据 类型 发生 含义
需要 您的Bonanza API开发人员ID
用户身份 需要 用户标识符 在排队背景烧录时分配给用户。通常,它是您的应用程序分配给用户的唯一ID。我们将为重复刻录相同类型图像的用户优化刻录性能。

成功的回应

成功的请求返回HTTP状态200。

所有请求中都包含响应值

返回值 类型 发生 含义
行动 总是 您向其发送请求的操作的名称。
信息 总是 请求结果的描述-成功或错误消息。
用户身份 总是 用户标识符 在排队背景烧录时分配给用户。
burn_user_id 整数 总是 刻录用户的Bonanza内部ID。
access_token 总是 没用过

包含的响应值 创造显示, 更新资料删除 要求

返回值 类型 发生 含义
ID 整数 总是 分配给此后台刻录的唯一ID
网址 总是 提交要刻录的远程图像URL
position_in_queue 整数 总是 后台刻录队列中的位置。完成烧伤将为0。直到开始燃烧为止的时间大约是5秒乘以队列中的位置
完成 布尔值 总是 如果刻录完成,则为true;如果正在等待或进行中,则为false
selected_mask_id 整数 有条件的 用户选择的背景遮罩的ID。如果未选择遮罩,则为null
final_result_url 有条件的 带有已应用所选蒙版的图像的URL。如果未选择遮罩,则为null
source_image_url 总是 上载图像的URL(存储在Bonanza的服务器上)
口罩 容器 有条件的 用于此刻录的所有可能的背景蒙版的数组。除非刻录完成,否则将为空
口罩。ID 整数 总是 分配给此背景遮罩的唯一ID
口罩。网址 总是 生成的背景遮罩图像的URL
口罩。Composite_url 总是 在源图像上合成的生成的背景蒙版图像的URL
口罩。变异 总是 用于生成背景蒙版的常规方法的名称。
口罩。quality_score 整数 总是 一个整数,描述我们对口罩质量的评估,其中更高的分数=可能更好的口罩
review_complete 布尔值 有条件地 当专家审查了烧伤后为真。仅适用于专家审核的会员资格

包含的响应值 指数 要求

返回值 类型 发生 含义
计数 整数 总是 返回给该用户的背景刻录数量(最多100个)。
background_burns 容器 总是 一系列背景烧伤
background_burns。ID 整数 总是 分配给此后台刻录的唯一ID
background_burns。网址 总是 提交要刻录的远程图像URL
background_burns。position_in_queue 整数 总是 后台刻录队列中的位置。完成烧伤将为0。直到开始燃烧为止的时间大约是5秒乘以队列中的位置
background_burns。完成 布尔值 总是 如果刻录完成,则为true;如果正在等待或进行中,则为false
background_burns。selected_mask_id 整数 有条件的 用户选择的背景遮罩的ID。如果未选择遮罩,则为null
background_burns。final_result_url 有条件的 带有已应用所选蒙版的图像的URL。如果未选择遮罩,则为null
background_burns。source_image_url 总是 上载图像的URL(存储在Bonanza的服务器上)
background_burns。口罩 容器 有条件的 用于此刻录的所有可能的背景蒙版的数组。除非刻录完成,否则将为空
background_burns。masks。ID 整数 总是 分配给此背景遮罩的唯一ID
background_burns。masks。网址 总是 生成的背景遮罩图像的URL
background_burns。masks。Composite_url 总是 在源图像上合成的生成的背景蒙版图像的URL
background_burns。masks。变异 总是 用于生成背景蒙版的常规方法的名称。
background_burns。masks。quality_score 整数 总是 一个整数,描述我们对口罩质量的评估,其中更高的分数=可能更好的口罩

错误回应

错误响应返回HTTP状态200。

返回值 类型 发生 含义
类型 总是 发生的错误的类型。
信息 总是 错误的解释。