聚石塔 Postman 接口使用指南
本文旨在提供一套能夠跑通聚石塔接口的 Postman Schema,幫助客戶(hù)快速完成對(duì)接。如果在對(duì)接中發(fā)現(xiàn)問(wèn)題,客戶(hù)可根據(jù) Postman 中接口的實(shí)現(xiàn)邏輯進(jìn)行核對(duì)修正。在使用本文檔時(shí),可配合 IDaaS-聚石塔對(duì)接文檔-v1.8.4.pdf 一同使用,能夠更佳清晰地了解業(yè)務(wù)邏輯。
導(dǎo)入 Schema
下載 聚石塔.postman_collection.json,導(dǎo)入到 Postman 中:
以上截圖基于 Postman v9.15.4,版本不同界面展示可能存在差異。
導(dǎo)入完成后,目錄結(jié)構(gòu)如下:
添加一個(gè)環(huán)境,然后切換到該環(huán)境:
至此,準(zhǔn)備工作已經(jīng)完成,接下來(lái)開(kāi)始調(diào)試接口。請(qǐng)按順序執(zhí)行接口,接口之間存在依賴(lài)關(guān)系,先執(zhí)行的接口為后執(zhí)行的接口提供環(huán)境變量。
初始化變量
首先,需要執(zhí)行【初始化變量】:
url 可以任意填寫(xiě),目的是為了能夠執(zhí)行腳本。
如果客戶(hù)尚未購(gòu)買(mǎi)實(shí)例,需要先對(duì)接,IDaaS 可以提供測(cè)試服務(wù)器供客戶(hù)提前對(duì)接。
接下來(lái)介紹如何獲取以上變量值。
host
host 即上圖中 “實(shí)例開(kāi)放接口域名”,特別注意聚石塔的版本為 idaas-jst-xxx,如果不是請(qǐng)立即聯(lián)系 IDaaS。
clientId 和 clientSecret
API Key為 clientId, API Secret為 clientSecret。
username、password、phoneNumber
接下來(lái)會(huì)使用這里的用戶(hù)信息調(diào)用接口創(chuàng)建賬號(hào)。用戶(hù)信息可以自行修改,但需要滿(mǎn)足約束條件。如果提示不滿(mǎn)足密碼策略,可以在 IDaaS 控制臺(tái)調(diào)整:
merchantName
商戶(hù)名稱(chēng)是上圖中的【掌柜】,務(wù)必傳對(duì),否則無(wú)法計(jì)分。
更準(zhǔn)確地是從接口中獲取,參考 接口文檔:
兩者值若不同,以接口為準(zhǔn)。
ivsAppKey
參考 接口文檔:
ivsAppKey 為上圖中的 App Key,務(wù)必傳對(duì),否則無(wú)法計(jì)分。
創(chuàng)建用戶(hù)流程
獲取 AccessToken
獲取 AccessToken ,為后續(xù)接口提供認(rèn)證需要的 token:
組織 / 查詢(xún)
查詢(xún)組織,將最后一個(gè)組織添加到環(huán)境變量,創(chuàng)建用戶(hù)時(shí)需要設(shè)置所屬的組織。
用戶(hù) / 新建
新建用戶(hù)時(shí),會(huì)使用上一步查詢(xún)出來(lái)的組織。創(chuàng)建用戶(hù)后,從 IDaaS 控制臺(tái)開(kāi)啟用戶(hù)二次認(rèn)證:
短信二次認(rèn)證流程
登錄
登錄時(shí),會(huì)自動(dòng)計(jì)算簽名并加密密碼。
登錄完成后,如果開(kāi)啟了二次認(rèn)證,會(huì)自動(dòng)添加 fid 環(huán)境變量。
短信二次認(rèn)證 - 發(fā)送驗(yàn)證碼
使用登錄返回的 fid,發(fā)送短信二次認(rèn)證驗(yàn)證碼。
發(fā)送二次認(rèn)證驗(yàn)證碼成功后,更新 fid。
短信二次認(rèn)證 - 校驗(yàn)驗(yàn)證碼
使用上一步返回的 fid,校驗(yàn)短信二次認(rèn)證驗(yàn)證碼。code 傳入手機(jī)上收到的驗(yàn)證碼,如果沒(méi)有收到驗(yàn)證碼,請(qǐng)?jiān)?IDaaS 控制臺(tái)通過(guò)日志核實(shí)是否發(fā)送成功:
OTP 綁定流程
登錄
同上。
OTP - 獲取綁定二維碼
獲取成功自動(dòng)設(shè)置 fid 環(huán)境變量。
使用 Base64 圖片轉(zhuǎn)換網(wǎng)站 https://tool.chinaz.com/tools/imgtobase/ 展示 OTP 綁定二維碼,拷貝base64QRCode的值,添加前綴 data:image/png;base64, :
使用 Google 身份認(rèn)證器(或其他認(rèn)證器),掃描二維碼,獲取 OTP Code:
OTP - 綁定
輸入上一步中獲取的 OTP Code。如果上一步操作時(shí)間過(guò)長(zhǎng),會(huì)導(dǎo)致 fid 失效,需要重新登錄。登錄后調(diào)用【OTP - 獲取綁定二維碼】,因?yàn)橹耙呀?jīng)綁定過(guò)了,現(xiàn)在直接從認(rèn)證器獲取 OTP Code 調(diào)用【OTP - 綁定】。
OTP 二次認(rèn)證流程
登錄
同上。
OTP - 校驗(yàn)
輸入從認(rèn)證器中獲取的 OTP Code。