API 概述

Clipping Magic 为图像上载和结果下载自动化提供以 REST 为主导的网络 API。 您可以用 ClippingMagic.js 将 Clipping Magic 编辑器集成入您的网站，让您的用户在您的网站上直接删除背景。

API 对于需要从用户提供的图像删除背景的网站以及配备删除图像流中图像的图形设计师工作人员的电子商务网站特别有用。

如需使用 API，您将需要一个 API 键和一些网络编程技能。

操作理论

终端用户删除背景

典型的方案是终端用户将图像上载至您的网站，您希望启用用户从该图像删除背景功能，作为您的网站图像工作流的一部分。 您通常会采取的步骤是：

  1. 您的用户将一幅图像上传至了您的网站。

  2. 您的后端服务器将图像通过后端 API 传至ClippingMagic.com，并获得图像 ID 和密钥。

    您的网页客户出于安全原因无法将图像直接上传至ClippingMagic.com。

  3. 您的后端服务器将图像 ID 和密钥传送至您的网页客户。 如果您在使用 AJAX，这一信息可包括在图像上传的回复内。 否则可嵌入您作为用户图像上传回复而生成的网页。

  4. 在您的网站上，通过让您的 javascript 代码调用编辑单张图像工作流以及来自上一步的图像 ID 和密钥，允许终端用户用 ClippingMagic.js 删除背景。

  5. 一旦收到来自 ClippingMagic.js 的result-generated回拨，您的 javascript 代码立即通知您的后端从该图像下载结果。

  6. 您的后端服务器下载结果并继续执行您的具体网站工作流中的后续步骤。

内部工作人员删除背景

典型的方案是您有很长一份需要处理的图像列表，一些工作人员负责处理这些图像。您通常需要执行的步骤是：

  1. 通过后端 API 将一批图像上载至 ClippingMagic.com，一次上载一个图像。 分别获得和储存图像 ID 和密钥。

  2. 在您的内部系统中，将图像按照适当的批处理分配给工作人员。 然后让每一名工作人员用 ClippingMagic.js 从批处理中删除背景，使用编辑多张图像序列工作流以及来自步骤 1 的对应图像 ID 和密钥。

    取决于您的图像的大小和细节，典型的批处理尺寸在 10 至 100 之间。

  3. 一旦收到来自 ClippingMagic.js 的result-generated回拨，立即通知您的后端从该图像下载结果。

  4. 重复整个程序。

后端与前端

请注意，所有上载和下载操作在后端发生，但裁剪操作使用 ClippingMagic.js 在网络客户端（前端）进行。

该拆分保护您的 API 键，同时启动在您的网站上的终端用户无缝体验。

详细信息

  • 您可以用测试模式使用 API，无需注册订阅，但为了真正使用，您需要注册 API 订阅。
  • 对不起，普通网站订阅没有 API 存取功能。
  • 您可以通过主 Clipping Magic 网站上的 API 查看和编辑所有上载的图像（当作为 API 用户登入时），反之亦可。 这在调试时或在您需要查看 API 图像流时会非常有用。
  • 尽管美国 API 速率限制，请有礼貌，不要过度使用。
  • 您的 http 客户端库必须支持服务器名称指示（SNI）才能成功地提出请求。 如果您得到奇怪的握手错误，则很可能是握手错误。

反馈

是否有任何遗漏或未充分记录的信息？您的实施是否要求附加特征？

请务必告诉我们，我们会尝试解决您的问题！