Respostas & exceções

APIResponse, BulkAPIResponse e FileAPIResponse são objetos no pacote para respostas dos APIs do Zoho CRM. Todos os API chamando métodos devem retornar um desses dois objetos.

  • Uma entidade de busca de método deve retornar o objeto APIResponse, enquanto uma lista de buscas de métodos deve retornar o objeto BulkAPIResponse.
  • FileAPIResponse será retornado para APIs de download de arquivos para baixar uma foto ou anexo de um registro ou nota, como record.downloadPhoto, record.downloadAttachment etc.
  • Use o método getData() para obter os dados da entidade sozinhos pelos objetos no pacote de resposta. APIResponse.getData() deve retornar um único objeto de entidade do Zoho CRM, enquanto BulkAPIResponse.getData() deve retornar uma lista de objetos de entidade do Zoho CRM.
  • FileAPIResponse tem dois métodos definidos chamados FileAPIResponse.getFileName(), que retorna o nome do arquivo baixado, e FileAPIResponse.getFileAsStream(), que oferece o conteúdo do arquivo como InputStream.

Além de dados, esses objetos em pacote de resposta têm as seguintes propriedades:

  1. ResponseHeaders - contagem de API restantes para o dia/janela presente e tempo passado para a redefinição da janela presente.
  2. ResponseInfo - quaisquer outras informações, se fornecidas pela API, além dos dados reais.
  3. Lista<EntityResponse> - status de entidades em uma API de lote. Por exemplo: uma API de registros de inserção pode falhar parcialmente devido a alguns registros. Esse array fornece o status de criação de registros individuais.

Iniciar o aplicativo

O SDK requer que a seguinte linha de código seja chamada sempre que o aplicativo for iniciado.

ZCRMRestClient.initialize();

Esse método deve ser chamado pela classe principal do aplicativo Java para iniciar o aplicativo. Ele precisa ser chamado sem qualquer exceção.

Verificar exceções

Todos os comportamentos inesperados, como falhas em respostas da API e anomalias do SDK, são manipulados pelo SDK e passados como uma única exceção — ZCRMException. Portanto, basta capturar essa exceção sozinha no código de aplicativo do cliente.