2014-02-18 65 views
0

我們在亞利桑那大學有一個網站,它使用紅光和綠光指示器顯示系統的狀態。我們希望添加監視Valence API狀態的功能,以確定它是否正常運行。有沒有人有任何使用JavaScript編寫的示例代碼,只會告訴API是否功能?我已經檢查了入門樣本,雖然有用,但從一開始的Valence API開發人員有點壓倒性。我不需要從特定的用戶環境中獲取任何東西,我不認爲這樣做只是簡單地拉動一些東西,而這些東西只是告訴我,Desire2Learn的Valence API正在響應可能就足夠了。任何指針都非常感謝。用Valence API編程的新手段

非常感謝你提前。

亞利桑那

的傑夫主教 大學
+0

請注意,您只能在沒有用戶上下文的情況下進行非常少量的調用:您可以請求有關後端API版本的信息,並且您可以請求用戶ID /密鑰對。所有真正有效的學習框架API調用_require_您需要有一個用戶ID /密鑰對來驗證:作爲框架背後的主要設計原則,您所有的調用都是在auth'd應用程序和auth'd用戶,如通過在呼叫的查詢字符串上發送的簽名所證明的。 –

回答

0

有沒有具體的 「ping」 API調用。 Valence Learning Framework API內置於LMS的Web服務核心應用程序層,因此如果LMS啓動並運行(並且API的支持已正確配置),那麼您應該可以進行API調用。也就是說,每個客戶端應用程序應該在其工作生命週期中作出的標準調用是查詢API contracts that the back-end service has available。實際上,您可以匿名進行此調用,而不需要特定用戶的用戶ID /密鑰對,因此,在某些情況下,此調用可用作心跳或ping(儘管我們還應強調將其純粹用作心跳/ ping呼叫可能不是一個好主意,因爲你所做的只是產生不需要的流量)。

與其試圖定期「檢查」Learning Framework API是否「啓動」,您應該認爲它是LMS可用的固有屬性:它可用(LMS啓動時)或配置錯誤。無論哪種情況,問題都不在於API本身,或者使用API​​調用進行修復。

您的應用程序設計應該假設API可供您使用(假設您有一個用於實際LMS用戶的ID /密鑰對),並且應該優雅地應對失敗。

+0

我們已經有了監視服務的工具,所以我想知道是否需要做一個簡單的「Get Versions」API調用。我的意思是,假設如果Valence部署在D2L實例上並且D2L已啓動並且對用戶有用,那麼不需要爲API本身進行監視過程是否安全?我只是不清楚這個策略是否有必要。任何反饋非常感謝。 – user3325403

+0

我會說API的健康度實際上是由兩件事來衡量的:(a)LMS本身是否上升?如果LMS的Web服務器已啓動,並且LMS本身在功能上可供在線用戶使用,那麼API可能(至少能夠),以及(b)客戶端應用程序能否成功獲取用戶ID /密鑰對用戶?第二個問題往往難以確定,但這確實是一次性的配置問題:除了某些罕見的情況,它確實是一個「當設置好,它正常工作」的事情。請注意,如果您更改了此配置的各個方面,那麼可能會導致迴歸無法正常工作。 –