响应和异常
APIResponse、BulkAPIResponse 和 FileAPIResponse 是 Zoho CRM API 的响应的包装器对象。所有 API 调用方法将返回三个对象的其中之一。
- 搜寻实体的方法将返回 APIResponse 对象,搜寻实体列表的方法将返回 BulkAPIResponse 对象。
- 对于文件下载 API,将返回 FileAPIResponse 以从 record.downloadPhoto、record.downloadAttachment 之类的记录或注释中下载照片或附件。
- 使用 getData() 方法可单独从响应包装器对象获取实体数据。APIResponse.getData() 将返回单个 Zoho CRM 实体对象,BulkAPIResponse.getData() 将返回 Zoho CRM 实体对象列表。
- FileAPIResponse 有两个已定义方法,一个是 FileAPIResponse.getFileName()(返回所下载的文件的名称),另一个是 FileAPIResponse.getFileAsStream()(以 InputStream 形式给出文件内容)。
这些响应包装器对象具有以下属性而不是数据:
- ResponseHeaders - 当天/当前窗口的余下 API 计数以及当前窗口重置的经历时间。
- ResponseInfo - 实际数据及 API 提供的任何其他信息。
- List<EntityResponse> - 批量 API 中的各个实体的状态。例如,插入记录 API 可能因为几个记录而部分失败。此数组给出各个记录的创建状态。
启动应用
每次启用您的应用时,该 SDK 需要调用以下代码行。
ZCRMRestClient.initialize();
应从 java 应用程序的 main 类调用此方法以启动该应用程序。调用它时不应出现任何异常。
检查异常
所有意外行为(例如,故障 API 响应和 SDK 异常)由 SDK 处理,并仅作为单个异常(ZCRMException)抛出。因此,在客户端应用代码中单独捕获此异常已经足够了。