ProcessOn API - 开发文档

概览

ProcessOn API简介

ProcessOn API 是ProcessOn团队开发的一套应用接口，基于ProcessOn API，您可以将ProcessOn作图工具无缝嵌入到您的网站中，不需要任何软件安装和插件，接入成功后，用户即可以在基于web的编辑器中打开ProcessOn作图工具以查看、新建和编辑图形。接口标准，快速响应，让用户轻松作图。

ProcessOn API 目前支持流程图、思维导图、UML、原型图、组织结构图等官网支持的所有类型的图形。

适合哪些开发者接入？

ProcessOn API可以接入任何电脑端基于web的应用或网站。尤其适合以下两类用户接入使用。

将流程图、思维导图等作为业务流程或服务的一部分的上下游合作伙伴：低成本为用户提供闭环的服务体验，用户数据由您自己保存，助力您的业务增长。
需要高频使用流程图和思维导图的企业。可以将ProcessOn API嵌入到您企业的内部协作工具中。作图工具嵌入到自己的网站，图形数据也存储在自己的平台，有利于保护企业数据安全。

api运行流程：

接入ProcessOn API以后用户在合作伙伴平台进行新建、编辑、浏览和保存图形文件时，数据传输和交互如下图所示：

开始使用

每一个使用 ProcessOn 服务的合作伙伴都应该有一个独立的 ProcessOn API帐户、唯一的API key和一个或多个域名。合作伙伴每次进行API调用、检索数据或执行特定操作都需要向ProcessOn API发送请求，并且需要API key 和回调域名作为必填参数。我们会将您发送的API key和域名与您注册时所填信息进行比对，校验成功后，我们会将响应数据到返回到发送请求的域名。您需要做好数据接收工作。

如果您开始在您的网站和应用使用ProcessOn API服务，您需要在ProcessOn API网站（https://api.processon.com/ ）创建账户并注册API key，并且需要购买充足的接口会话次数。具体如下：

1. 创建一个ProcessOn API账户

打开注册页面：http://api.processon.com/signup
填写手机号、获取验证码、创建登录密码
点击注册，完成账户创建

2. 生成 API key

合作伙伴可以通过以下步骤生成ProcessOn API key:

打开生成API key页面：http://api.processon.com/apply
填写完整的公司名称，公司描述以及必须要绑定的一个或多个域名（以英文逗号分隔）

同意我们的服务协议后，点击提交按钮，即可生成对应的唯一的API key, 并跳转到控制台

每个ProcessOn API账户的API key是唯一的，注意保护API key私有，不要分发使用。发送请求时API key 和回调域名会与您绑定的域名比对校验。违规操作可能导致您的API key取消或账户锁定。

注意:
当您创建一个ProcessOn API帐户并生成一个API key 后，系统默认赠送您 50 个接口调用次数。如果使用中您的调用次数不足，您可以随时按您的需求升级套餐。在控制台可以随时检查您接口调用情况：https://api.processon.com/console。

3. 升级套餐

前两步完成后，您可以根据您的需求升级套餐：

点击控制台，可以查看您购买的套餐信息
点击 “升级套餐”，可以升级套餐或再次购买
根据您的需要选择对用的套餐，点击升级
选择支付方式完成支付流程，即可成功升级套餐

新建/编辑

代码：

<form method="POST" action="https://api.processon.com/openapi/diagrams" target="iframeName" accept-charset="UTF-8">
    <input type="hidden" name="appkey" value="您的appkey">
    <input type="hidden" name="chartid" value="第三方网站对应的文件id">
    <input type="hidden" name="category" value="mind">
    <input type="hidden" name="title" value="未命名文件">
    <input type="hidden" name="def" value="从ProcessOn获取的文件定义(新建时默认为空)">
    <input type="hidden" name="callbackurl" value=您的回调地址需要与注册appKey时的域名保持一致。>
    <input type="hidden" name="hidebtn" value=是否隐藏工具栏保存按钮(默认false)>
    <input type="submit" name="submit" value="新建/编辑文件">
</form><iframe name="iframeName"></iframe>

使用场景：

在第三方应用中，点击新建或者编辑的时候，使用以上代码提交表单，ProcessOn API会返回一个新建或编辑文件的设计器嵌入至您的 iframe 中。

注：< form >中的method、action、accept-charset属性不需要变动。target="_self"表示本页面，推荐您使用页面中iframe的name属性，作为target的值，表示新建或者编辑页面出现在已存在的iframe中。查看代码示例

参数说明：

参数	类型	必填	描述
appkey	String	true	注册应用后，申请的appKey
category	String	true	文件类型，可选类型有:flow(流程图)、mind(思维导图)、network(网络拓扑图)、venn(韦恩图)、mind_org(组织结构图)、uml
chartid	String	true	在第三方应用中对应的文件ID
title	String	true	文件标题名称
def	String	false	文件数据（为空字符串时表示新建文件；获取存到第三方应用的数据，赋值给此项，表示编辑文件）
callbackurl	String	true	回调URL，用于点击保存时，ProcessOn API向第三方应用推送数据的地址，您的回调地址需要与注册appKey时的域名保持一致。
hidebtn	String	false	是否隐藏工具栏保存按钮(默认false)。

用户交互时序图：

返回错误代码：

代码	描述
4000	参数app_key无效
4001	参数callbackurl无效
4002	参数def无效
4003	参数callbackurl与提供的回调地址不匹配
4004	接口会话数不足
4005	非法请求
4006	账号无效

浏览

代码

<form method="POST" action="https://api.processon.com/openapi/diagrams/view" target="iframeName" accept-charset="UTF-8">
    <input type="hidden" name="appkey" value="您的appkey">
    <input type="hidden" name="category" value="mind">
    <input type="hidden" name="title" value="未命名文件">
    <input type="hidden" name="def" value="从ProcessOn获取的文件定义">
    <input type="submit" name="submit" value="浏览文件">
</form><iframe name="iframeName"></iframe>

使用场景：

在第三方应用中，点击新建或者编辑的时候，使用以上代码提交表单，ProcessOn API会返回一个新建或编辑文件的设计器嵌入至您的 iframe 中。

注：< form >中的method、action、accept-charset属性不需要变动。target="_self"表示本页面，推荐您使用页面中iframe的name属性，作为target的值，表示新建或者编辑页面出现在已存在的iframe中。查看代码示例

参数说明：

参数	类型	必填	描述
appkey	String	true	注册应用后，申请的appKey
category	String	true	文件类型，可选类型有:flow(流程图)、mind(思维导图)、network(网络拓扑图)、venn(韦恩图)、mind_org(组织结构图)、uml
title	String	false	文件标题名称
def	String	true	文件数据（获取存到第三方应用的数据，赋值给此项，表示浏览文件）

保存文件

用户作图过程中可随时点击保存，ProcessOn API会将数据，通过[callbackurl]推送给第三方应用

推送给第三方应用的参数:

{
					   "chartid": "第三方应用对应的文件ID ",

					   "def": "ProcessOn官方的图形数据",
					   "size": "ProcessOn官方的图形数据大小，单位为KB",
					}

参数说明：

参数	类型	描述
chartid	String	第三方应用对应的文件ID
def	String	ProcessOn官方的图形数据，第三方应用需要使用长字符串类型保存此数据。
size	String	ProcessOn官方的图形数据大小，单位为KB。
valid	Boolean	是否有效文件定义(流程图零元素或思维图形无节点时返回false)。

返回结果：

将保存结果返回给ProcessOn API，success、error等用于展示给用户。

用户交互时序图：

下载

代码

<form method="POST" action="https://api.processon.com/openapi/diagrams/export" target="iframeName" accept-charset="UTF-8">
    <input type="hidden" name="appkey" value="您的appkey">
    <input type="hidden" name="chartid" value="第三方网站对应的文件id">
    <input type="hidden" name="category" value="mind">
    <input type="hidden" name="title" value="未命名文件">
    <input type="hidden" name="def" value="从ProcessOn获取的文件定义">
    <input type="hidden" name="type" value="image">
    <input type="submit" name="submit" value="下载文件">
</form><iframe name="iframeName"></iframe>

使用场景：

在第三方应用中，点击下载的时候，使用以上代码提交表单，ProcessOn API会返下载最新文件至浏览器。

注：< form >中的method、action、accept-charset属性不需要变动。target="_self"表示本页面，推荐您使用页面中iframe的name属性，作为target的值，表示新建或者编辑页面出现在已存在的iframe中。查看代码示例

参数说明：

参数	类型	必填	描述
appkey	String	true	注册应用后，申请的appKey
chartid	String	true	第三方应用对应的文件ID
type	String	true	下载文件格式可选类型有:image(图片)、pdf(PDF文件)
category	String	true	文件类型，可选类型有:flow(流程图)、mind(思维导图)、network(网络拓扑图)、venn(韦恩图)、mind_org(组织结构图)、uml
title	String	true	文件标题名称
def	String	true	文件数据（获取存到第三方应用的数据，赋值给此项，表示浏览文件）

账户预览

您将可以登录到https://api.processon.com并随时查看与您的帐户和使用情况相关的详细信息。

升级套餐

用户每次新建，和编辑图形文件时，需要调取ProcessOn的接口。ProcessOn Api按照成功调取的次数收取费用。ProcessOn Api调取的次数已经按照不同企业的需求打包成不同规格的套餐。您可以根据您的需求在控制台点击 “升级”进行购买。购买成功后可在订单中查看已经购买的套餐。 ProcessOn目前提供四种规格套餐，请您按需购买

ProcessOn API 文档

概览

ProcessOn API简介

适合哪些开发者接入？

api运行流程：

开始使用

1. 创建一个ProcessOn API账户

2. 生成 API key

3. 升级套餐

新建/编辑

浏览

保存文件

下载

账户预览

升级套餐