
如何快速實現REST API集成以優化業務流程
3.1、根據開發環境選擇對應的集成文檔
點擊應用控制臺界面的【Android/iOS/Harmony集成】,進入對應的集成頁面。開發者根據自身的開發環境選擇對應的集成文檔進行集成,默認的文檔為原生項目的文檔。如果非原生開發項目請選擇【客戶端集成插件】,找到對應類型的文檔。
注:集成中所需要用到的AppKey、scheme、關聯域名(Associated Domains) 均可在【Android集成】、【iOS集成】、【Harmony集成】中對應的【應用配置】中查看到。
3.2、根據開發環境選擇對應的集成文檔
找到對應的文檔后,按照文檔的集成流程進行插件導入、文檔代碼集成加入操作。
SDK集成操作完成后,需要將應用的相關配置信息填充到控制臺。填充方式分為:自動配置、手動配置。
自動配置:導出集成完畢的App測試包上傳至控制臺,上傳后系統會自動解析安裝包進行信息填充。
手動配置:無需導出App測試包,直接填寫對應的應用信息在對應位置后保存即可。
5.1、【App傳參安裝功能測試】:
(1)打包上傳測試
測試前需要先卸載手機上已安裝的App。訪問Android集成、iOS集成界面右上角的【在線測試】網頁或已集成【Web集成】文檔的網頁下載安裝App,并啟動App,最后查看安裝參數獲取方法(getInstall)中自定義參數的獲取情況。
(2)真機調試測試
測試前需要先卸載手機上已安裝的App。訪問Android集成、iOS集成界面右上角的【在線測試】網頁或已集成【Web集成】文檔的網頁,打開網頁后點擊一下網頁上的下載按鈕,但不用確認下載。然后使用開發工具(例如AndroidStudio、Xcode等)安裝app到該手機上并啟動,最后查看安裝參數獲取方法(getInstall)中自定義參數的獲取情況。
5.2、【一鍵拉起功能測試】:
在手機上安裝好對應的App,然后訪問【在線測試】網頁或已集成【Web集成】文檔的網頁,點擊按鈕,會喚醒對應的App。然后查看喚醒回調方法(wakeup)的喚醒參數的獲取情況。
5.3、【H5渠道統計功能測試】:
進入openinstall賬號應用中的【H5渠道統計】模塊的【H5渠道管理】,創建渠道鏈接,然后參考5.1點的【App傳參安裝功能測試】規則測試即可。渠道鏈接測試才能獲取到對應的渠道編號。
6.1、自行開發網頁集成【Web集成】文檔
openinstall控制臺所提供的測試網頁僅供開發者功能測試驗證用途,禁止用于正式環境正式使用。因此開發者正式使用時需要自行開發下載落地頁(H5),然后網頁中需要集成【Web集成】文檔,來達到與測試頁一樣的功能。 JavaScript集成或者App banner集成,二選一即可:
6.2、安裝包下載地址配置
高級版:付費開通后支持上傳安裝包下載,Android推薦使用“常規路由”或“加速路由(需消耗加速路由流量包)”,也可以選擇自行配置下載地址在對應下載地址欄中(Android為“自定義下載地址”,iOS為“Appstore或其他”)。
初級版:openinstall測試包僅供功能測試驗證,禁止在正式環境大量使用。因此開發者需要自行提供安裝包地址配置到對應的下載配置中。
6.3、開發者認證
初級版和高級版在正式使用前都需要進行開發者認證。否則【初級版】會存在每日ip測試上限,【高級版】會存在每日ip測試上限以及無法付費開通。
【初級版】:進入【基本信息】,手動切換至“初級版”即可。 注意:“高級版”付費開通后無法切換回“初級版”。
【高級版】:進入應用控制臺界面的【基本信息】,點擊【商用支付】選擇對應的服務套餐付費開通即可。
在應用頁面左側導航欄中應用集成>數據接口可以查看到密鑰
提示:應用及渠道的所有統計數據,均以HTTP接口的形式向開發者開放,開發者可通過這些數據接口抓取數據自行存儲,或做報表二次開發;數據接口默認關閉。
在獲取API密鑰后,進行可用性測試是確保其正常工作的重要步驟。以下是使用curl進行測試的一個案例
以下接口為openinstall開放平臺數據接口中的渠道分組列表接口
輸入:
curl -X GET "https://data.openinstall.io/data/group/list" \
-H "Content-Type: application/json" \
-H "apiKey: <您的API_KEY>"
輸出:
你將得到一個JSON格式的響應,其中包含了當前應用下所有的渠道分組信息。
示例輸出:
{
? "code": 0,
? "error": null,
? "body": [
? ? ? {"groupName":"default"},
? ? ? {"groupName":"巨量"},
? ? ? {"groupName":"百度OCPC"},
? ? ? {"groupName":"分享"}
? ]
}
在使用openinstall開放平臺 API搭建應用時,除了獲取和測試API密鑰外,還需考慮以下因素:
應用及渠道的所有統計數據,均以HTTP接口的形式向開發者開放,開發者可通過這些數據接口抓取數據自行存儲,或做報表二次開發。
請開發者注冊并登錄openinstall后臺,找到【數據接口】-【接口配置】,開啟數據接口開關等配置。
在開發應用時,確保 OpenInstall 的 API 能夠無縫支持 Android 和 iOS 操作系統。考慮到不同操作系統的要求,選擇適合的開發框架,并確保 API 在這些平臺上都能正常工作。此外,還要考慮設備的不同型號和操作系統版本,確保應用的兼容性。
在使用 OpenInstall API 時,必須確保符合相關隱私法規。這意味著開發者需要清楚地告知用戶其數據如何被收集、使用和存儲,尤其是有關渠道和用戶行為數據的收集。開發者應確保應用的隱私政策清晰透明,并采取適當的措施來保障用戶隱私。
若應用需要與第三方廣告平臺(如 Google Ads、Facebook Ads)或數據分析工具(如 Google Analytics、Mixpanel)集成,開發者應確認 OpenInstall API 與這些工具的兼容性。通過與其他服務的集成,開發者可以獲得更多的推廣渠道和深入的用戶行為分析。
在申請和使用 openinstall開放平臺 API密鑰過程中,你可能會遇到以下常見問題:
1.App傳參安裝方法(getinstall)每次進入都會回調怎樣避免?
SDK初始化成功后內部將會一直保存安裝參數,每次調用App傳參安裝方法都會返回安裝參數。如果開發者并不需要每次進入App都觸發此方法,可以將該方法放在業務場景真正需要獲取安裝參數時調用,其次在獲取完成后如果不需要再次獲取時,可以通過自行設置標識以便于下次不再調用此方法。
2.作為OpenInstall用戶,自己應用的下載鏈接或二維碼在哪里獲取?
OpenInstall平臺提供的【在線測試】鏈接、二維碼和“系統默認”的渠道鏈接、二維碼僅供測試。
若OpenInstall用戶想要在自行開發的網頁中實現與“測試頁”相同功能,則需要在自行開發的網頁中加入【web集成】-【JavaScript集成】或【App banner集成】文檔,從而實現App傳參安裝、渠道統計、一鍵拉起、快速安裝等功能。(網頁鏈接可以使用工具轉換成二維碼圖片,此時的鏈接與二維碼功能等效)
3.微信/支付寶小程序中顯示OpenInstall相關域名未非業務域名的處理辦法?
(1)當微信/支付寶小程序中加載集成了OpenInstall web集成文檔的網頁時,可能會出現:不支持打開非業務域名https://xxxxxx.openinstall.io
,請重新配置。如果出現此類提示,則屬于OpenInstall相關域名未在對應的小程序中進行白名單驗證,從而不屬于業務域名禁止訪問。 (2)驗證流程: ①按照小程序平臺的驗證規則,將對應的驗證文件(.txt或.html文件)發送至OpenInstall官方人員,官方人員會轉交技術將文件配置到對應域名的根目錄下。 ②添加對應域名根目錄下后,就可以進行驗證了。驗證成功后告知OpenInstall官方人員即可(驗證成功后OpenInstall會清除該驗證文件)。
4.怎樣為應用開通或續費?
(1)進入OpenInstall控制臺中對應的應用,然后進入應用控制臺的【基本信息】,即可看到開通/續費選項(初級版無付費選項)。 (2)進入OpenInstall控制臺,點擊界面右上角的【財務】-【我的錢包】充值所需的費用。然后回到應用列表為對應的應用開通/續費。 (3)在OpenInstall控制臺的應用列表也可以為應用開啟自動續費,須保證【我的錢包】中余額充足,否則會影響自動續費。
在獲得openinstall開放平臺 API密鑰之后,即可開啟API接口對接,本文整理了多篇使用openinstall開放平臺 API的案例,幫助讀者更有效地使用openinstall開放平臺 API:
渠道詳情、渠道創建/修改、子渠道列表、新增安裝數據、活躍數據、新增設備分布
問題1: 什么是冪簡集成平臺?
冪簡集成是蜜堂有信在2023年打造的一款SAAS產品,建設著國內最全的API平臺,為開發者提供全面、高效、易用的API集成管理方案,一站搜索、試用、集成國內和國外API。讓用戶在AI時代全方位接入互聯網,用API連接一切服務和算力,實現價值倍增。
問題2:如何找到openinstall開放平臺 API
冪簡API平臺可以通過以下兩種方式找到所需API:通過關鍵詞搜索API(例如,輸入’openinstall開放平臺 API‘這類品類詞,更容易找到結果)、或者從API hub分類頁進入尋找。
更多競品可以在openinstall開放平臺找到。
本文介紹了openinstall開放平臺的API密鑰獲取、測試及應用開發過程中的關鍵考慮因素。首先,我們通過curl命令演示了如何測試API密鑰的可用性。接著,闡述了使用API搭建應用時的其他重要注意事項,包括數據接口、接口配置、平臺兼容性、用戶隱私保護以及第三方工具集成。此外,還解決了在API密鑰申請和使用過程中可能遇到的常見問題,并提供了進階使用指引和相關鏈接,幫助開發者更好地應用openinstall平臺的API進行開發和集成。