2. 獲取密鑰

1. 登錄以后進入個人中心,復制app_key 和app_secrect

3. 代碼接入

接口參數 若無特殊說明,接口參數同時支持GET和POST傳遞;推薦:查詢/刪除用GET,創建/更新用POST。

參數名字參數類型是否必須默認值備注參數說明
app_key字符串必須最?。?2公共參數?開發者應用的app_key,查看我的app_key,如果還沒有,可免費注冊開通。
sign字符串可選公共參數接口簽名,其中:
使用動態簽名,簽名生成算法請見:如何生成簽名,或直接使用封裝好的SDK開發包,通過在線測試工具可進行簽名的對比和調試。使用靜態簽名,點擊獲取我的靜態簽名關閉簽名,如果不需要簽名,可進入小白開放平臺接口簽名設置關閉或開啟簽名。定制簽名支持專屬簽名算法定制開發
uuid字符串可選公共參數?UUID,當前登錄的應用會員ID,即全局唯一用戶ID,查看我的應用會員。傳遞此參數后,可以在開放平臺查看每日活躍會員統計圖表。uuid需要和token一起傳遞。
token字符串可選公共參數?當前登錄會員的會話憑證,可通過會員登錄接口獲得。uuid需要和token一起傳遞。
return_data字符串可選0公共參數 數據返回結構,其中:
return_data=0,返回完整的接口結果,示例:{"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,返回簡潔的接口結果,只返回data字段,結構簡化一級,更扁平,示例:{"err_code":0,"err_msg":"V3.1.0 YesApi App.Hello.World","title":"Hi YesApi,歡迎使用小白開放接口!"}
model_name字符串必須表單名稱(對應在小白開放平臺創建時的數據庫表名稱),查看我的全部表單
model_uuid字符串可選最大:32表單UUID,即對應表單數據里的uuid字段。分為三種情況:model_uuid為@NULL或未提供時(默認值):如model_uuid=@NULL,即不限制uuid,可匹配任意uuid,包括uuid為空和不為空的數據紀錄;model_uuid為空字符串:為空字符串時,如model_uuid=,只匹配uuid為空字符串的數據紀錄(即游客數據);model_uuid為具體的值:如model_uuid=8AEA2AF1951C0376EC668A74B8CAA64A,則進行精確匹配,只匹配與表單uuid相等的數據紀錄。
check_code字符串可選最大:64待檢測的口令,僅當在小白開放平臺配置口令后才會對此參數進行檢測,規則配置教程
data字符串JSON格式可選創建時的初始化數據,需要JSON編碼后傳遞。格式:data={“字段名1″:”字段值1″,”字段名2”:”字段值2″…}。數據中的uuid將優先于model_uuid參數。JSON在線解析及格式化驗證(data和data_X二選一)
data_X字符串可選動態參數,優先于data的JSON數據??勺杂蓚魅雱討B參數,字段名組合格式:data_ + X(X要換成你的字段名),例如數據表單標題title字段,組合后為:&data_title=YesApi,等效于:&data={“title”:”YesApi”}??梢酝瑫r傳入多個動態參數,例如:&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={動態簽名}

請求(使用data_X動態參數傳遞,data和data_X二選一):
{你的接口域名}/?s=App.Table.Create&model_name=article&data_title=123456&app_key={你的app_key}&sign={動態簽名}

返回:
{
"ret": 200,
"data": {
"err_code": 0,
"err_msg": "",
"id": 4
},
"msg": ""
}

接口返回及數據結構

返回字段類型說明
ret整型接口狀態碼,200表示成功,4xx表示客戶端非法請求,5xx表示服務端異常,查看異常錯誤碼
dataobject/array/混合接口返回的業務數據,由不同的API接口決定不同的數據返回字段和結構。當return_data=1時,接口只會返回此data字段。
data.err_code整型狀態操作碼,0成功;1創建失敗(不符合表字段要求,或表字段不存在);2應用層規則攔截,攔截后可以小白開放平臺查看日記
data.err_msg字符串錯誤提示信息,err_code非0時參考此提示信息
data.id整型新創建數據的自增ID
msg字符串提示信息,面向技術人員的幫助或錯誤提示信息
_t整數服務器當時Unix時間戳,例如:1657513450
_auth字符串反向數字簽名,可用于客戶端進行反向驗證,防止數據篡改,例如:9bcd54ff53e71a1d80d37c52bdfabf76。驗證算法:_auth = md5(data返回的JSON字符串 + _t當前時間戳字符串 + APP_SECRECT密鑰字符串),若需要關閉或開啟請提交工單

4. 常見問題

Q:如何找到果創云 API開放平臺

A:冪簡集成是國內領先的API集成管理平臺,專注于為開發者提供全面、高效、易用的API集成解決方案。冪簡API平臺可以通過以下兩種方式找到所需API:通過關鍵詞搜索API(例如,輸入’果創云 API開放平臺‘這類品類詞,更容易找到結果)、或者從API hub分類頁進入尋找。

Q:出現?414 Request-URI Too Large?時怎么解決?
A:對于全部參數,改用POST方式傳遞,并且從GET鏈接里面去掉。

Q:瀏覽器請求和在線測試接口正常,但本地程序無法正常獲取接口結果?
A:需要注意UTF編碼,以及存在中文和特殊字符時的URL編碼。GET請求參數應統一進行URL編碼后再請求,POST表單數據正常傳遞即可。

Q:請求接口時提示JSON格式錯誤?
A:請先閱讀,然后檢測本地傳遞的參數是否符合JSON格式,使用JSON在線工具輔助檢測,注意雙引號和特殊符號。確認無誤后再重新請求API接口。

Q:出現?405 不允許跨域請求?時怎么辦?
A:可以追加GET參數?&yesapi_allow_origin=1,或參考用反向代理解決跨域問題等3種解決方案。

Q:果創云 API開放平臺的替代品有哪些?

除了果創云 API開放平臺,還有其他替代服務商也提供類似api服務,例如:

LeanCloud API開放平臺、天聚數行 API開放平臺、API Store API開放平臺

更多競品可以在冪簡集成開放平臺中找到。

Q:果創云 API開放平臺這個密鑰還適用于哪些api?

1830 隨機獲取一條數據接口、1808 批量極速創建新數據接口[二分法遞歸增強版]?1802 創建非重復新數據接口

5.? 總結

本文全面且細致地介紹了如何獲取果創云API開放平臺密鑰的分步指南,為開發者們提供了一份條理清晰、操作簡便的實用手冊。從果創云API平臺的賬號注冊,到完成開發者身份驗證,再到最終成功獲取API密鑰,每一步操作都配以詳盡的說明與指導,確保開發者能夠輕松、準確地完成整個流程。獲取密鑰只是利用果創云API的第一步,如何高效、穩定地集成并應用其提供的豐富功能才是關鍵。因此,建議開發者在獲取密鑰后,進行相應的可用性測試,確保API能夠順利集成到應用中并發揮出最佳效果。本文為開發者們提供了一個全面、詳盡且極具實用性的操作指南,幫助他們順利獲取果創云API開放平臺的密鑰,并將這一強大的數據處理與信息服務能力有效地集成到應用中。我們相信,隨著開發者們對這一指南的深入理解和實踐,將能夠在應用開發中取得更加顯著的成果,為應用的智能化、高效化發展注入新的活力,進而提升應用的性能和用戶體驗。

上一篇:

如何獲釘釘開放平臺 API Key 密鑰(分步指南)

下一篇:

如何獲取 Parseur Pte Ltd. 開放平臺 API Key 密鑰(分步指南)
#你可能也喜歡這些API文章!

我們有何不同?

API服務商零注冊

多API并行試用

數據驅動選型,提升決策效率

查看全部API→
??

熱門場景實測,選對API

#AI文本生成大模型API

對比大模型API的內容創意新穎性、情感共鳴力、商業轉化潛力

25個渠道
一鍵對比試用API 限時免費

#AI深度推理大模型API

對比大模型API的邏輯推理準確性、分析深度、可視化建議合理性

10個渠道
一鍵對比試用API 限時免費