跳至主要内容

API的一些基礎知識


適讀對象為無代碼基礎的讀者,本文結閤工作流中的發送API請求,簡單介紹API接口的一些基礎知識。

什麼是API

API(Application Programming Interface,應用程序接口),是軟件開發者將某個做好功能開放給外部人員使用的一個窗口。外部人員無需訪問源碼或理解內部代碼處理細節,隻需要按API規定的格式傳遞一些參數,即可獲取期望的數據或執行期望的操作。

例如一個典型的API接口服務:查詢手機號的歸屬地。

http://apis.juhe.cn/mobile/get?key=4c80e35a4220b955a2932a38e6511e9e&phone=15838082573

點開此鏈接打開頁麵,查詢的15838082573的歸屬地,您隻需修改地址欄中【phone=】後麵的手機號,按迴車,即可查詢另一個手機號的歸屬地。

這就是API服務,您隻需在請求時給服務器傳遞參數,無需理會如何實現,即可獲取到期望的內容。

API請求的組成

什麼是請求,API接口的調用,是通過一個URL地址傳輸的,URL打開一次就是一次請求,刷新頁麵,又算一次請求。

請求API接口,其實就是打開訪問接口的URL,此URL在請求時需要幾個組成部分:

  • API接口地址

    即API接口服務公開給外部訪問的地址

  • 請求方式

    常用的有Get 、Post 和其他方式,這取決於API接口服務,無需理解,他們支持什麼,我們選擇對應的方式即可。

  • 請求的參數

    API接口根據你傳遞的參數處理對應的數據。例如,URL中的phone就是一個參數

  • 授權認證方式

    在請求API時,不是誰請求都會處理,需要對您的請求做認證。常見的是 token 認證和key(有時還有會結閤sign)。這些信息API服務商都會給到您。

  • Header

    請求過程中需要傳遞的錶頭信息,是係統級的參數,包含存儲認證信息Token的參數。一般情況下我們不需要配置,需要配置時,API文檔中會特彆說明。

  • Body

    同樣也是存儲傳遞的數據,它在請求方式為Post時纔需要配置。常用來存儲錶單信息,有時授權認證的參數也可以存儲在這裏。

    例如,通過API接口,將一個錶單數據新增到第三方係統,錶單的字段名稱和字段值存放在Body中。

總體來說:調用API 接口時,需要三部分:

  1. 請求的API URL地址
  2. 傳遞的參數
  3. 授權身份認證

圖文舉例

舉例1:查詢手機號歸屬地 (Get 方式)

接口服務商:聚閤數據

API地址: http://apis.juhe.cn/mobile/get

請求方式: Get

傳遞的參數: phone(手機號)、key(服務商分配的身份認證碼)

授權認證方式: 通過申請的key來驗證身份。這種認證方式可以將Key拼接在URL中,通過一個URL即可完成請求。

Header: 沒特彆說明,無需配置

Body: Get方式 無需配置

將請求地址和參數進行拼接,得到請求的完整URL(參數間用&鏈接,第一個參數前麵加?)

http://apis.juhe.cn/mobile/get?key=4c80e35a4220b955a2932a38e6511e9e&phone=15838082573

以下是API返迴的數據(JSON格式),彆擔心看不懂,係統可以接收並處理好這些數據。

在工作流中的的配置如下,每個節點作用:

  • 觸發節點:當一個聯係人的手機號填寫或修改時,觸發流程,
  • 發送API請求節點:根據手機號請求API,獲取到此手機號的歸屬地,
  • 更新記錄節點:將歸屬地信息更新到聯係人記錄中。

舉例2:獲取企業的工商信息(Get 方式)

接口服務商:天眼查  

API地址: http://open.api.tianyancha.com/services/open/ic/baseinfo/2.0

請求方式: Get

傳遞的參數: id 或 name  (因為說明中寫瞭,隻輸入一個即可,不然需要全部傳遞)

授權認證方式:token認證,但需要通過header傳遞。

首先,我們拼接好完整的請求URL

http://open.api.tianyancha.com/services/open/ic/baseinfo/2.0?name=平安銀行股份有限公司

Header配置

由於此接口的授權認證方式,為Token認證,且需要將Token的值 通過header傳遞,因此不能僅通過一個URL就能調用API。需要配置Header

隻要是通過header 傳遞 Token,則header中的字段名都是Authorization,此字段專門用來存放認證信息的。

在工作流中的Webhook的配置如下,將拼接的請求URL和Header 分彆配置到 Webhook URL 和Header 中。

每個節點的作用:

  • 觸發節點:當客戶記錄的 公司全稱填寫或修改時,觸發流程
  • 發送API請求節點:調用API接口獲取到此企業的基本信息
  • 更新記錄節點:將獲取的信息更新到客戶記錄中

舉例3:通過API嚮工作錶中新增一行記錄 (Post 方式)

我們就以工作錶API為例,介紹如何嚮錶中新增一行記錄。

首先來看下工作錶API

從API介紹中可以看到, 請求的方式是 Post,隻需配置 請求URL 和 參數即可。

授權認證方式為 appkey + sign , 和參數一起,配置在Body中即可。

Body 中 支持兩種參數提交格式

Key-value pairs :簡單說,就像圖中配置那樣,左邊是參數名,右邊是參數的值。

Raw(application/json) : 是將參數和參數值 轉化為 Json格式傳遞,一般需要程序員配置處理

在工作流中的 Webhook的配置如下,將請求的URL和參數 分彆配置到 Webhook URL 和Body中。

每個節點的作用:

  • 觸發節點:當《公開報名錶》有新記錄錄入時
  • 發送API請求節點:通過《人員登記錶》的API,嚮此錶發送新增數據,直接新增一條記錄。


文檔問題反饋

文檔中是否有錯彆字、內容過期、難以理解等問題? 點此給我們反饋吧