鍵.png)
使用這些基本 REST API 最佳實(shí)踐構(gòu)建出色的 API
1. 登錄以后進(jìn)入個(gè)人中心,復(fù)制app_key 和app_secrect
參數(shù)名字 | 參數(shù)類型 | 是否必須 | 默認(rèn)值 | 備注 | 參數(shù)說明 |
---|---|---|---|---|---|
app_key | 字符串 | 必須 | 最?。?2 | 公共參數(shù)?開發(fā)者應(yīng)用的app_key,查看我的app_key,如果還沒有,可免費(fèi)注冊開通。 | |
sign | 字符串 | 可選 | 公共參數(shù)接口簽名,其中: 使用動態(tài)簽名,簽名生成算法請見:如何生成簽名,或直接使用封裝好的SDK開發(fā)包,通過在線測試工具可進(jìn)行簽名的對比和調(diào)試。使用靜態(tài)簽名,點(diǎn)擊獲取我的靜態(tài)簽名關(guān)閉簽名,如果不需要簽名,可進(jìn)入小白開放平臺接口簽名設(shè)置關(guān)閉或開啟簽名。定制簽名支持專屬簽名算法定制開發(fā) | ||
uuid | 字符串 | 可選 | 公共參數(shù)?UUID,當(dāng)前登錄的應(yīng)用會員ID,即全局唯一用戶ID,查看我的應(yīng)用會員。傳遞此參數(shù)后,可以在開放平臺查看每日活躍會員統(tǒng)計(jì)圖表。uuid需要和token一起傳遞。 | ||
token | 字符串 | 可選 | 公共參數(shù)?當(dāng)前登錄會員的會話憑證,可通過會員登錄接口獲得。uuid需要和token一起傳遞。 | ||
return_data | 字符串 | 可選 | 0 | 公共參數(shù) 數(shù)據(jù)返回結(jié)構(gòu),其中: return_data=0,返回完整的接口結(jié)果,示例: {"ret":200,"data":{"err_code":0,"err_msg":"","title":"Hi YesApi,歡迎使用小白開放接口!"},"msg":"V3.1.0 YesApi App.Hello.World","_t": 1657513450, "_auth": "9bcd54ff53e71a1d80d37c52bdfabf76"} ;return_data=1,返回簡潔的接口結(jié)果,只返回data字段,結(jié)構(gòu)簡化一級,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,歡迎使用小白開放接口!"} 。 | |
model_name | 字符串 | 必須 | 表單名稱(對應(yīng)在小白開放平臺創(chuàng)建時(shí)的數(shù)據(jù)庫表名稱),查看我的全部表單 | ||
model_uuid | 字符串 | 可選 | 最大:32 | 表單UUID,即對應(yīng)表單數(shù)據(jù)里的uuid字段。分為三種情況:model_uuid為@NULL或未提供時(shí)(默認(rèn)值):如model_uuid=@NULL ,即不限制uuid,可匹配任意uuid,包括uuid為空和不為空的數(shù)據(jù)紀(jì)錄;model_uuid為空字符串:為空字符串時(shí),如model_uuid= ,只匹配uuid為空字符串的數(shù)據(jù)紀(jì)錄(即游客數(shù)據(jù));model_uuid為具體的值:如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A ,則進(jìn)行精確匹配,只匹配與表單uuid相等的數(shù)據(jù)紀(jì)錄。 | |
check_code | 字符串 | 可選 | 最大:64 | 待檢測的口令,僅當(dāng)在小白開放平臺配置口令后才會對此參數(shù)進(jìn)行檢測,規(guī)則配置教程 | |
data | 字符串JSON格式 | 可選 | 創(chuàng)建時(shí)的初始化數(shù)據(jù),需要JSON編碼后傳遞。格式:data={“字段名1″:”字段值1″,”字段名2”:”字段值2″…}。數(shù)據(jù)中的uuid將優(yōu)先于model_uuid參數(shù)。JSON在線解析及格式化驗(yàn)證(data和data_X二選一) | ||
data_X | 字符串 | 可選 | 動態(tài)參數(shù),優(yōu)先于data的JSON數(shù)據(jù)??勺杂蓚魅雱討B(tài)參數(shù),字段名組合格式:data_ + X(X要換成你的字段名) ,例如數(shù)據(jù)表單標(biāo)題title字段,組合后為:&data_title=YesApi,等效于:&data={“title”:”YesApi”}。可以同時(shí)傳入多個(gè)動態(tài)參數(shù),例如:&data_title=YesApi&data_year=2020,比JSON格式更方便(data和data_X二選一) |
請求示例
請求(使用data的JSON格式傳遞,data和data_X二選一):
{你的接口域名}/?s=App.Table.Create&model_name=article&data={"title":"123456"}&app_key={你的app_key}&sign={動態(tài)簽名}
請求(使用data_X動態(tài)參數(shù)傳遞,data和data_X二選一):
{你的接口域名}/?s=App.Table.Create&model_name=article&data_title=123456&app_key={你的app_key}&sign={動態(tài)簽名}
返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"id": 4
},
"msg": ""
}
返回字段 | 類型 | 說明 |
---|---|---|
ret | 整型 | 接口狀態(tài)碼,200表示成功,4xx表示客戶端非法請求,5xx表示服務(wù)端異常,查看異常錯(cuò)誤碼 |
data | object/array/混合 | 接口返回的業(yè)務(wù)數(shù)據(jù),由不同的API接口決定不同的數(shù)據(jù)返回字段和結(jié)構(gòu)。當(dāng)return_data=1時(shí),接口只會返回此data字段。 |
data.err_code | 整型 | 狀態(tài)操作碼,0成功;1創(chuàng)建失敗(不符合表字段要求,或表字段不存在);2應(yīng)用層規(guī)則攔截,攔截后可以小白開放平臺查看日記 |
data.err_msg | 字符串 | 錯(cuò)誤提示信息,err_code非0時(shí)參考此提示信息 |
data.id | 整型 | 新創(chuàng)建數(shù)據(jù)的自增ID |
msg | 字符串 | 提示信息,面向技術(shù)人員的幫助或錯(cuò)誤提示信息 |
_t | 整數(shù) | 服務(wù)器當(dāng)時(shí)Unix時(shí)間戳,例如:1657513450 |
_auth | 字符串 | 反向數(shù)字簽名,可用于客戶端進(jìn)行反向驗(yàn)證,防止數(shù)據(jù)篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。驗(yàn)證算法:_auth = md5(data返回的JSON字符串 + _t當(dāng)前時(shí)間戳字符串 + APP_SECRECT密鑰字符串) ,若需要關(guān)閉或開啟請?zhí)峤还?/td> |
Q:如何找到果創(chuàng)云 API開放平臺
A:冪簡集成是國內(nèi)領(lǐng)先的API集成管理平臺,專注于為開發(fā)者提供全面、高效、易用的API集成解決方案。冪簡API平臺可以通過以下兩種方式找到所需API:通過關(guān)鍵詞搜索API(例如,輸入’果創(chuàng)云 API開放平臺‘這類品類詞,更容易找到結(jié)果)、或者從API hub分類頁進(jìn)入尋找。
Q:出現(xiàn)?414 Request-URI Too Large?時(shí)怎么解決?
A:對于全部參數(shù),改用POST方式傳遞,并且從GET鏈接里面去掉。
Q:瀏覽器請求和在線測試接口正常,但本地程序無法正常獲取接口結(jié)果?
A:需要注意UTF編碼,以及存在中文和特殊字符時(shí)的URL編碼。GET請求參數(shù)應(yīng)統(tǒng)一進(jìn)行URL編碼后再請求,POST表單數(shù)據(jù)正常傳遞即可。
Q:請求接口時(shí)提示JSON格式錯(cuò)誤?
A:請先閱讀,然后檢測本地傳遞的參數(shù)是否符合JSON格式,使用JSON在線工具輔助檢測,注意雙引號和特殊符號。確認(rèn)無誤后再重新請求API接口。
Q:出現(xiàn)?405 不允許跨域請求?時(shí)怎么辦?
A:可以追加GET參數(shù)?&yesapi_allow_origin=1
,或參考用反向代理解決跨域問題等3種解決方案。
除了果創(chuàng)云 API開放平臺,還有其他替代服務(wù)商也提供類似api服務(wù),例如:
LeanCloud API開放平臺、天聚數(shù)行 API開放平臺、API Store API開放平臺
更多競品可以在冪簡集成開放平臺中找到。
Q:果創(chuàng)云 API開放平臺這個(gè)密鑰還適用于哪些api?
1830 隨機(jī)獲取一條數(shù)據(jù)接口、1808 批量極速創(chuàng)建新數(shù)據(jù)接口[二分法遞歸增強(qiáng)版]?、1802 創(chuàng)建非重復(fù)新數(shù)據(jù)接口
本文全面且細(xì)致地介紹了如何獲取果創(chuàng)云API開放平臺密鑰的分步指南,為開發(fā)者們提供了一份條理清晰、操作簡便的實(shí)用手冊。從果創(chuàng)云API平臺的賬號注冊,到完成開發(fā)者身份驗(yàn)證,再到最終成功獲取API密鑰,每一步操作都配以詳盡的說明與指導(dǎo),確保開發(fā)者能夠輕松、準(zhǔn)確地完成整個(gè)流程。獲取密鑰只是利用果創(chuàng)云API的第一步,如何高效、穩(wěn)定地集成并應(yīng)用其提供的豐富功能才是關(guān)鍵。因此,建議開發(fā)者在獲取密鑰后,進(jìn)行相應(yīng)的可用性測試,確保API能夠順利集成到應(yīng)用中并發(fā)揮出最佳效果。本文為開發(fā)者們提供了一個(gè)全面、詳盡且極具實(shí)用性的操作指南,幫助他們順利獲取果創(chuàng)云API開放平臺的密鑰,并將這一強(qiáng)大的數(shù)據(jù)處理與信息服務(wù)能力有效地集成到應(yīng)用中。我們相信,隨著開發(fā)者們對這一指南的深入理解和實(shí)踐,將能夠在應(yīng)用開發(fā)中取得更加顯著的成果,為應(yīng)用的智能化、高效化發(fā)展注入新的活力,進(jìn)而提升應(yīng)用的性能和用戶體驗(yàn)。