Draftable Compare API(文件比较技术集成工具)

　　Draftable Compare API是一款用于比较文档的REST API，此工具的作用就是为用户提供一个文件比较的技术脚本，同时还为用户提供了所有脚本比较的介绍，让用户可以把文本比较技术嵌入到应用程序中，从而可以更好的为用户提供帮助，该API接受一对文档，并返回比较查看器URL；在基于云的API中，支持Word，Powerpoint和PDF文件，目前，在企业自托管API中，仅支持PDF文件；比较查看器是可嵌入的，并显示文档的并排比较，文档以其原始格式显示，并突出显示更改；使用该程序客户端库，可以很容易地从C＃/，NET，Java，Python或Node.js进行集成；从其他语言开始，它通常只是一个简单的HTTP请求；需要的用户可以下载体验

新版特性

　　多合一比较查看器

　　我们进行突出显示，渲染和平滑同步滚动，您需要做的就是嵌入它。

　　为企业准备

　　经过严格测试和严格测试的Draftable API已用于比较超过500万份文档，服务水平保证可用。

　　客制化

　　使用我们的白色标签选项个性化体验，或者做得更好，为您的品牌定制查看器。

　　端到端加密

　　您的文件很重要，我们在运输和休息的每个阶段都使用企业级安全性。访问控制

　　根据权限结构，您可以完全控制谁可以访问您的比较，以及可以访问多长时间。高性能比较

　　我们的比较的速度，质量和易用性将给您的用户留下深刻的印象。使他们的工作更轻松，更高效。

　　自托管选项

　　可草拟的API自托管API是为内部部署而构建的。

　　它作为虚拟设备提供，并且比较完全在该设备中运行。

　　这意味着可以保证您数据的机密性和隐私性。

软件特色

　　Draftable API是开发人员为开发人员创建的简单REST API。

　　开箱即用，即可为绩效更高的团队提供所需的一切

　　在几分钟之内将文档比较集成到您的应用程序中。

　　易于整合

　　如果您使用C＃/.NET，Java，Python或Node.js，则我们的客户端库使集成变得容易。

　　从其他语言开始，您仍然可以使用我们的简单REST API。

　　如果不确定您是否需要本地解决方案，建议您从可草稿托管选项开始。

　　这两个选项提供了相同的API，因此以后可以轻松切换到“可草稿的API自托管”。

　　在此阶段，仅支持PDF比较，但是有许多选项可用于支持其他文件类型。

安装步骤

　　1、用户可以点击本网站提供的下载路径下载得到对应的程序安装包

　　2、只需要使用解压功能将压缩包打开，双击主程序即可进行安装，弹出程序安装界面

　　3、安装该程序需要电脑网络环境为.net 4.6，不然就无法安装

　　4、根据提示点击安装，弹出程序安装完成界面

使用说明

　　您需要创建一个帐户才能开始使用API。

　　使用对我们端点的HTTP请求创建并显示比较。可用的端点记录在我们的API资源管理器中。如果您使用的是C＃/。NET，Java，Python或Node.js，则还可以使用我们的客户端库通过更简单的界面与API进行交互。

　　比较

　　通过将文件提交到端点来创建比较。文件可以作为URL给出，也可以直接上传。创建比较后，比较将由我们的服务器处理以生成差异。通常，可以在几秒钟内显示比较结果。

　　每个比较都有专用的查看器URL，通过该URL，用户可以对文档进行并排比较。在比较过程中，它将显示加载动画。

　　安全与认证

　　所有API请求都需要身份验证。此外，默认情况下，所有比较都是私有的，并且需要授权才能查看。（如果要授予公共访问权限，则必须将它们明确标记为公共。）

　　简单的例子

　　让我们尝试提交和查看比较。这是您需要的：

　　您的帐户控制台中的测试凭据。

　　curl，或通过https提交请求的另一种方式。

　　创建比较

　　要进行比较，我们将向发出POST请求。我们将使用可草稿托管的一些演示文件。https://api.draftable.com/v1/comparisons

　　注意：用测试凭证中的auth令牌替换。{auth_token}

　　解释回应

　　响应将是一个包含的JSON对象，该对象是此比较的唯一标识符，以及其他元数据。identifier

　　查看比较

　　要查看比较，只需导航到查看器URL。

　　注意：替换为响应中的标识符和测试凭据中的帐户ID。{identifier}{account_id}

　　https://api.draftable.com/v1/comparisons/{account_id}/{identifier}

　　奖励：嵌入比较

　　要嵌入比较，只需将查看器网址放入iframe中即可。

　　API资源管理器

　　这是API端点的主要参考。我们已经详细描述了每个端点期望的参数以及返回的响应。

　　需要注意的重要一点是，比较是不可变的（即，它们的属性不能更改）。因此，只有，和端点。POSTGETDELETE

　　您尚未登录。您可以浏览API提供的选项，但是以下操作只有在登录后才能起作用。

　　测试帐户ID：需要登录测试身份验证令牌：需要登录

　　比较生命周期

　　建立比较

　　向API端点提交请求以创建比较。

　　一个效应初探表示成功提交。201 CREATED

　　比较状态

　　通过向端点发送请求来获取比较状态。注意，表示比较是否已处理。完整的响应在API Explorer中进行了描述。GET/comparisons/{identifier}ready

　　比较还没有准备好

　　当为时，您的比较正在处理中。通常，此过程不应超过几秒钟。如果用户查看此比较，它将显示一个加载屏幕。readyfalse

　　比较已经准备就绪，但是失败了

　　当is 和is时，比较文档时出错。将始终包含错误消息。如果用户查看了此比较，则页面将显示无法比较文件。readytruefailedtrue

　　比较已准备就绪且成功

　　当is 和is时，可以将比较显示给用户。注意：何时为，并且始终存在。readytruefailedfalse

　　查看比较

　　通过导航到查看器URL来查看比较。

　　https://api.draftable.com/v1/comparisons/viewer/{account_id}/{identifier}

　　查看器URL要求：

　　account_id-您的帐户ID

　　identifier-比较的唯一标识符

　　注意：当比较尚未准备好时，查看器将显示加载动画。如果比较失败，将显示错误消息。请参阅比较查看器参考。

　　私人与公共比较

　　默认情况下，比较是私有的。只需浏览到查看器URL，即可查看公共比较。私有比较需要授权以URL参数的形式查看。

　　https://api.draftable.com/v1/comparisons/viewer/{account_id}/{identifier}?valid_until=1485661253&signature=a68bf9a68bf9a68bf9

　　向用户显示比较

　　虽然可以通过查看器URL将用户直接发送到比较，但建议将比较直接嵌入到您的应用程序中。

　　删除比较

　　要删除比较，只需将请求发送到端点。成功后，将给出空响应。DELETE/comparisons/{identifier}204 NO CONTENT

　　自动删除

　　请求中的参数确定何时将自动删除比较。默认情况下，如果未指定，则不会自动删除比较。expiry_timePOSTexpiry_time

　　例如，向API端点提交一个请求以创建一个比较，包括expiry_time参数。时间戳记应始终遵循ISO_8601格式。POST/comparisons

　　异步使用

　　创建比较时，如果让Draftable生成，则需要等待POST请求完成，然后才能知道要使用的查看器URL。identifier

　　在某些情况下，您可能想在创建比较之前向查看者显示。例如，如果将文件上传给我们需要几秒钟，您可能希望在后台流程中创建比较，但立即将查看器URL发送给您的用户。

　　为此，您可以在POST请求中使用自定义标识符创建比较。

　　生成自定义标识符

　　定制的idenfitier有一些限制：

　　它只能包含字母数字字符（az，AZ，0-9）和 -._

　　它必须包含1到1024个字符。

　　它必须是唯一的-即您不能使用与现有比较相同的标识符。如果提供的标识符不是唯一的，则会收到响应，并且不会创建比较。注意：删除比较后，您可以再次使用其标识符。400 BAD REQUEST

　　使用自定义标识符

　　要使用自定义标识符，请在POST请求中包括以下字段：

　　相应的查看器URL将使用给定的自定义标识符。

　　注意：虽然尚未创建比较，但查看器默认会给出响应。您需要在GET参数中指定，以告知查看器等待比较存在。404 NOT FOUNDwait

　　这是一个公开比较的示例：

　　https://api.draftable.com/v1/comparisons/viewer/{account_id}/{custom_identifier}?wait

　　和一个私人比较：

　　https://api.draftable.com/v1/comparisons/viewer/{account_id}/{custom_identifier}?wait&valid_until=...&signature=...

　　Draftable维护着几个开源客户端库，从而使使用C＃/。NET，Java，Python和Node.js的API变得容易。

　　每个库都是API的瘦包装，用于处理发出请求以及身份验证和签名。这些库在GitHub的自述文件中有完整记录。

　　自托管配置

　　Draftable客户端库可与云和自托管的Draftable一起使用。

　　要连接到您的自托管实例，请将基本API URL作为第三个参数传递。请注意，URL必须以“ / v1”结尾，并且不带斜杠。