A API do Zenvia Customer Cloud oferece funcionalidades que permitem consultar informações de anexos diretamente via requisições HTTP. Com essa API, é possível integrar e realizar o download dos anexos ao seu sistema, automatizando consultas e recuperando arquivos específicos.
Administração de APIs
Para utilizar a API, é necessário obter um Token de Autenticação, que deve ser enviado em todas as requisições via cabeçalho. Esse token pode ser gerado no painel de controle do Atendimento de suporte - Enterprise, seguindo os passos abaixo:
- Acesse o menu Configurações.
- Vá até Conta > Parâmetros.
- Na aba Ambiente, role até o final da página para encontrar o Token. Copie a chave fornecida.
Esse token deve ser tratado como uma chave de segurança, evitando compartilhamentos não autorizados.
Além do Token de Autenticação, será necessário o Hash de algum arquivo, que pode ser encontrado utilizando outras APIs do sistema, como a API de tickets.
Com a chave de autenticação e o Hash em mãos, escolha uma ferramenta para testar a API. Recomendamos o uso do Postman, um software amplamente utilizado para testar e manipular APIs com facilidade.
Passo a passo para testes no Postman
- Abra o Postman e crie uma nova requisição.
- No campo de URL, insira o endpoint da API que você deseja consultar. Por exemplo, para listar um anexo, utilize o seguinte endpoint:
https://api.movidesk.com/public/v1/storage/download?token=TOKEN&id=HASH - Cole a chave do Token no campo correspondente a Token.
- Cole o Hash no campo ID, obtido a partir da consulta prévia de APIs.
- Selecione o método HTTP adequado, neste caso, GET.
- Clique em Send para enviar a requisição à API.
Limites e segurança
A API possui um limite de 10 requisições por minuto para garantir um desempenho estável. Se o seu cenário exigir um volume maior de requisições, entre em contato com o suporte técnico para análise de viabilidade. Para mais informações, consulte a documentação oficial sobre horários e limites das APIs.
Integração com a API: Realizar download de um anexo
O download de um anexo específico pode ser realizado através do seu ID (Hash). O endpoint para essa operação é:
- URL: /public/v1/storage/download?token=TOKEN&id=HASH
- Método: GET
Propriedade | Tipo | Descrição |
token | string | Token do sistema |
id | string | Hash identificador do anexo |
Exemplo de requisição no Postman:
GET
https://api.movidesk.com/public/v1/storage/download?token=88888888-8888-8888-8888-888888888888&id=44444444444444444444444444444444
Essa requisição retornará o anexo correspondente ao ID fornecido. Caso o formato do anexo seja suportado pelo Postman, o conteúdo será exibido em pré-visualização.
Exemplos de Resposta
- Caso o ID não seja encontrado ou o Token esteja inválido:
- Retorno: HTTP Status 404.
- Caso o ID seja encontrado com sucesso:
- Retorno: HTTP Status 200.
- O arquivo será enviado no formato correspondente com o Content-Type apropriado para download.