灵长科技API管理平台接入方法说明

1. 系统介绍

2. 下载安装

3. 初始化设置

4. LICENSE获取

5. 启动CEAMS系统

6. 技术支持

1. 系统介绍

灵长科技CEAMS通用企业应用接口管理系统(以下简称为CEAMS)为用户提供基于Node.js的云端微服务应用开发运维,以及API管理解决方案。CEAMS为各类云端应用和服务资源提供基于浏览器的在线一体化开发、调试、部署、监控管理、访问认证等能力。用户可在CEAMS系统上使用大量方便的云端服务应用的自动化开发和管理功能,例如自动化测试工具、代码和文档生成,无中断时间的一键升级和回滚应用版本,应用代码下载上传、版本比较等方便的功能。

CEAMS系统为用户提供基于网页的统一在线应用门户中心,用户可在其中查看系统中部署的各类在线应用,同时提供对应用的分类和检索能力。CEAMS系统提供在线测试、浏览API文档和范例代码等功能方便对接应用接口,以及提供基于API接口的服务发现能力。

为方便开发,CEAMS系统为用户的云端应用提供统一的API规范,以及基于该规范的HTTP + JSON的API调用接口,方便各类客户端应用接入。开发云端应用时,用户首先在平台上编辑并生成应用的API规范。基于该API规范,平台为应用提供各项方便的自动化能力,例如API文档自动生成、应用框架代码自动生成、基于JSON schema的严格数据校验能力、API全自动及手动测试、灵活的API数据缓存和限流保护等能力。

平台提供完整的Node.js NPM生态支持(https://www.npmjs.com),用户可自由引用NPM生态中70多万个各类开源包中的任意一个,例如各类工具库、数据库驱动,消息中间件接口等,帮助方便地开发其云端应用和对接到各类异构系统资源。同时,平台提供各类常用协议支持,例如对REST API、SOAP的支持,可帮助应用开发者方便地连接并从其他系统获取应用开发需要的数据和能力。

更进一步,在获得相应权限后,用户的应用可通过系统中其他应用提供的API接口,以纯粹的JSON数据格式访问系统中部署的其他应用,通过数据组合查询和处理,灵活地组织和处理来自不同应用的JSON数据,在已有应用的基础上搭建出全新的流程应用。自由地创建和完成对各类服务的组合和编排能力。您可以通过以下的《CEAMS系统用户手册》和《CEAMS系统应用开发指南》了解更多关于CEAMS系统提供的各项能力。

2. 下载安装

目前CEAMS系统仅支持在基于Linux的操作系统上安装部署。请按照以下步骤在Linux操作系统上下载安装CEAMS系统。

1.操作系统

您可以在基于Ubuntu / Debian,或者CentOS / RHEL的Linux操作系统上安装和使用CEAMS系统。我们推荐您在Ubuntu 16.04,Debian 9,或者CentOS 7以上的服务器操作系统中安装CEAMS系统。

2.系统硬件要求

CEAMS系统运行的最低硬件配置为1CPU,4G内存,20G硬盘。 我们推荐在1CPU, 8G内存,40G硬盘或以上配置的服务器中安装和运行CEAMS系统。

3.下载安装方法

在一台全新安装的Linux操作系统上,可以使用以下的命令行安装CEAMS系统:

curl -sL https://www.apemesh.com/download/get-ceams.sh | sudo -E bash -

系统将自动下载docker, node.js等运行时环境,并将CEAMS系统通过网络下载安装到本地。 在此过程中,如果您的系统上已安装了旧版本的Node.js,系统会提示将其升级到Node.js V10.15 LTS版本,请接受并安装升级。

系统安装完成后,您可以在浏览器中,从服务器所在IP地址的3300端口访问CEAMS系统管理终端并完成必要的初始化设置。之后便可以登录管理终端,并从管理终端中启动CEAMS系统的网站服务器和应用服务器。

3. 初始化设置

在系统安装完成后,您可以在浏览器中输入以下URL以访问CEAMS系统的管理终端。我们推荐您在最新版的Chrome浏览器中访问和使用CEAMS系统。

http://<ip-addr>:3300/

以上<ip-addr>为安装CEAMS系统Linux主机的IP地址。

首次访问管理终端时需要完成初始化配置,页面如下图所示:

admin-console

您可以在以上的向导流程中完成对系统的初始化配置。通常情况下,您无需更改其中的任何配置,而是直接使用系统提供的默认配置。在完成设置后,请在以下页面输入并确认管理员用户的密码,并点击“完成”按钮结束初始化配置。

admin-console

在初始化设置完成后,您可以输入管理员用户的密码并登录管理终端。

4. LICENSE获取

您需要下载并部署LICENSE文件至CEAMS系统,方可将在系统上开发好的应用部署上线。为方便您对产品的评估,我们为您提供一个月时长的社区版免费LICENSE,您可以点击以下按钮获取。

如果您需要商业版LICENSE,请点击以下按钮并填写您的联系信息,我们的销售代表将尽快与您联系。

在获得LICENSE文件后,您可以在管理终端的“LICENSE管理”页面中,上传该文件并更新使用。

5. 启动CEAMS系统

在完成以上的管理终端初始化设置并登录到管理终端后,您可以在系统配置页面的“CEAMS网站服务器”和“CEAMS应用服务器” tab中分别启动CEAMS系统的网站服务器和应用服务器进程。启动成功后,应看到如下的,分别来自网站服务器和应用服务器的系统日志页面:

admin-console

admin-console

至此,CEAMS系统已完成安装并启动成功。您可以在浏览器中输入以下URL地址访问CEAMS系统:

http://<ip-addr>:3030/

以上<ip-addr>为安装CEAMS系统Linux主机的IP地址。

我们推荐您下载并阅读《CEAMS系统用户手册》《CEAMS系统应用开发指南》,进一步了解CEAMS系统上基于Node.js的微服务应用开发方法,以及各项API管理功能。

6. 技术支持

感谢您对我们产品的支持。您可以通过发送邮件至:support@apemesh.com,或者添加QQ群号:618450152 向我们询问和了解有关CEAMS系统的进一步问题。