Valence API编程新手

Question

我们在亚利桑那大学有一个网站，它使用红灯和绿灯指示灯来显示系统的状态。我们希望添加监视Valence API的状态的功能，只要它当前是否处于启动和正常运行状态。有没有人有用javascript编写的示例代码，可以简单地判断API是否正常工作？我已经检查了入门示例，虽然很有用，但作为Valence API开发人员的初学者，它有点让人应接不暇。我不需要从特定的用户上下文中提取任何东西，我不这么认为，简单地提取一些东西，告诉我Desire2Learn的Valence API正在响应可能就足够了。任何指点都是非常感谢的。

非常感谢你提前这么做。

亚利桑那州杰夫·毕晓普大学

Answer 1

没有特定的"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/密钥对)，并且应该优雅地处理失败。