概要
上次在北京的 DevCon 上,了解到大家对 FileMaker Data API 和小程序的一些话题非常感兴趣,所以我们就来跟大家分享一些相关的入门知识。
本系列一共分为 4 篇:1. Data API 概览;2. 案例演示-调试后台 API;3. 小程序开发环境部署;4. 案例演示-调用 Data API 开发小程序。其中第一、三篇会在飞沫课公众号和我们的入门视频教程推送,第二、四篇仅在入门视频教程发布。
FileMaker Data API 真香
Restful API 其实并不是一个新鲜的技术,但是是现在最通用的技术之一。在开放的互联网中,各种系统都通过 API 进行标准化对接。
我们在之前的公众号中也介绍过如何在 FileMaker 中调用其他系统的 API。但是,今天我们要说的是如果将 FileMaker 中的数据通过 API 输送给其他系统。这里,我忍不住要夸一下 FileMaker。正常来说要给一个系统增加对外分享数据的 API,需要数名具备 API 开发能力的高级后端开发者,花费很久的时间才能完成。
但是,在 FileMaker 提供了基础 API 之后,我们只要改一改脚本,就完成了 API 接口组的开发。我个人认为在 5-500 人并发、年 500万记录、无原生软件顺滑体验洁癖的需求场景下,FileMaker 的优势巨大。
了解 Data API 大类
FileMaker Data API 的文档随 Server 一起安装,当我们部署好服务器、域名、SSL 数字证书之后,可以在以下网址访问:https://{域名}/fmi/data/apidoc/。暂时没装的,可以下载从我们服务器拷贝出来的离线版。
FileMaker 提供的 6 大类 API:
1. metadata(元数据获取):这个部分的 API 主要给外部开发者参考,内部开发者对这些信息了如指掌,几乎不需要。
2. auth(登录验证):登录验证是必须的步骤,先通过 basic auth(用户名和密码)获取 access token,然后再通过 token 授权给后续 API。当然这里还支持 Google、微软的 OAuth,国内几乎不用,所以不讨论。
3. records(记录操作):这里提供了完整的获取、增加、修改、删除、查找、复制等记录的操作,不过我个人觉得用处一般。因为当我们去进行这些记录操作时,都是带有上下文场景的,即需要通过脚本来完成。所以,我们更多的情况是使用 script API,少量使用 records API。
4. scripts(脚本执行):这个 大类下只有一个『执行脚本』API,但是这是所有 API 里最重要的。我们本身具备的编写复杂脚本的能力,搭配『执行脚本』这个 API,就可以轻轻松松让前端开发者获取任何想要的数据。这个 API 让 FIleMaker 开发者原地获得了开发复杂 API 的技能。
4. container(容器上传):作用如名,需要就用。
6. globals(设置全局字段):作用如名,需要就用。
经过分析可以发现:当我们使用 Data API 开发小程序时,小程序只是完成了界面的渲染,逻辑计算的大部分工作都转移到服务器上进行。这跟原来使用 FileMaker 有一点区别,所以这时候选择服务器配置时,需要比原来只托管 FileMaker 的硬件配置更高。
阅读 Data API 文档
要了解一条 FileMaker API 的用法,主要需要关注以下几个方面:方法(HTTP 请求方法,分为:GET、POST、DELET、PATCH等)、路径(PATH)、地址参数(PATH PARAMETER)、头部(HEADER)、正文(BODY)、响应(RESPONSE)。
这几个部分已经全部标注到图中,请查看右边图片。
下面我们通过 cURL 方式登录和新建记录两个过程来给大家演示一下 FileMaker Data API 的应用。
下一篇,我们会介绍将要开发的案例。以及对此案例所用的 API,逐一用第三方工具先进行调试。
以上就是本文所有内容,欢迎需要案例链接的朋友给我们留言。
网友评论