Carregamento de um arquivo no Kommo

O ciclo de vida do arquivo começa com o processo de upload. Cada arquivo é enviado em partes, e o tamanho máximo de cada parte que pode ser carregada em uma única solicitação é retornado quando a sessão é aberta.

Se o seu arquivo exceder o tamanho máximo de parte obtido ao abrir a sessão, será necessário dividi-lo em partes menores que não ultrapassem esse limite.

Para iniciar o upload de um arquivo, primeiro é necessário abrir uma sessão para upload e especificar o tamanho e o tipo do arquivo a ser enviado. Isso é importante para que, em caso de problemas na rede, o upload possa ser retomado de onde parou, em vez de ser reiniciado do zero. Uma sessão de upload dura até que o arquivo seja completamente carregado, mas não mais do que 24 horas após a criação.

Ao abrir uma sessão, você receberá informações sobre o tamanho máximo das partes do arquivo e um link para carregar a primeira parte. Após o upload de cada parte, um link será fornecido para enviar a próxima. Assim que o arquivo for totalmente carregado, a sessão será automaticamente encerrada e as informações do arquivo serão retornadas.

Ao fazer o upload de um arquivo, você pode passar o ID de um arquivo existente para carregar uma nova versão. Ao gerenciar um arquivo via API, ele pode ser reutilizado em diferentes lugares, como em uma nota ou em um campo de arquivo.

Obtenção de uma lista de arquivos

A API de Arquivos fornece uma maneira de recuperar uma lista de arquivos (ativos ou excluídos). Além disso, é possível filtrar os resultados com base em determinados parâmetros, como extensão ou tamanho do arquivo.

Esse método é especialmente útil para integrações que precisam monitorar o status do armazenamento de arquivos ou para aquelas que desejam maximizar o uso de arquivos reutilizáveis.

Exclusão de arquivos

Ao receber a permissão Exclusão de arquivos, as integrações podem utilizar o método de exclusão em lote. Além disso, há um método de recuperação de arquivos caso algum seja deletado acidentalmente.

Esses métodos possuem um escopo separado para garantir que o usuário esteja ciente de que a integração tem o potencial de excluir arquivos e que a responsabilidade pela exclusão recai sobre a integração.

As integrações podem se beneficiar desses métodos ao obter maior flexibilidade e controle sobre seus arquivos.

Uma vez excluído, o arquivo é enviado para a lixeira e será permanentemente removido após 30 dias, liberando espaço assim que for movido para a lixeira.

Arquivos excluídos não podem ser usados em notas, campos ou qualquer outra parte do sistema.

Um arquivo como nota

Você pode usar um arquivo carregado como anexo a uma nota, adicionando uma nota via API de Notas e passando o uuid e o nome do arquivo para ser exibido na nota. Lembre-se de que, se quiser que um arquivo seja exibido em uma nota, deve-se adicionar duas notas com a mesma data de criação.

Um arquivo em um campo personalizado

Você também pode usar um arquivo carregado como o valor de um campo personalizado com "type": "file". Arquivos em campos suportam versionamento, então, se você fizer ajustes em um arquivo, poderá criar uma nova versão para o arquivo já carregado. Isso permite que o cliente veja todas as versões do arquivo e baixe cada uma delas. Por exemplo, uma integração pode gerar um contrato para uma transação específica, carregá-lo nos arquivos e, em seguida, defini-lo como valor de um campo.

Anexando um arquivo a uma entidade

Ao carregar um arquivo, você pode anexá-lo a uma ou mais entidades principais, incluindo leads, contatos e empresas. Os arquivos anexados serão exibidos na aba Mídia no cartão da entidade correspondente.

A aba Mídia exibe todos os arquivos recebidos do cliente ou carregados em uma nota, bem como aqueles adicionados ao cartão via API. No entanto, arquivos carregados em campos personalizados não serão exibidos na aba Mídia.

A API não apenas permite anexar arquivos, mas também removê-los e obter uma lista de todos os arquivos anexados.