互聯網服務對接—FileMaker 對接小程序入門 1

概要

上次在北京的 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:

互聯網服務對接—FileMaker 對接小程序入門 1 - Data API 概覽

  1. metadata(元數據獲取):這個部分的 API 主要給外部開發者參考,內部開發者對這些信息瞭如指掌,幾乎不需要。
  2. auth(登錄驗證):登錄驗證是必須的步驟,先通過 basic auth(用戶名和密碼)獲取 access token,然後再通過 token 授權給後續 API。當然這裡還支持 Google、微軟的 OAuth,國內幾乎不用,所以不討論。
  3. records(記錄操作):這裡提供了完整的獲取、增加、修改、刪除、查找、複製等記錄的操作,不過我個人覺得用處一般。因為當我們去進行這些記錄操作時,都是帶有上下文場景的,即需要通過腳本來完成。所以,我們更多的情況是使用>
  4. scripts(腳本執行):這個 大類下只有一個『執行腳本』API,但是這是所有 API 裡最重要的。我們本身具備的編寫複雜腳本的能力,搭配『執行腳本』這個 API,就可以輕輕鬆鬆讓前端開發者獲取任何想要的數據。這個 API 讓 FIleMaker 開發者原地獲得了開發複雜 API 的技能。
  5. 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 的應用。

互聯網服務對接—FileMaker 對接小程序入門 1 - Data API 概覽


互聯網服務對接—FileMaker 對接小程序入門 1 - Data API 概覽

下一篇,我們會介紹將要開發的案例。以及對此案例所用的 API,逐一用第三方工具先進行調試。

互聯網服務對接—FileMaker 對接小程序入門 1 - Data API 概覽


分享到:


相關文章: