Alterar arquivo

Este recurso permite alterar um arquivo para uma entidade fazendo o upload do conteúdo a partir de uma URL fornecida pelo cliente.

Depois que o arquivo é alterado e estiver ativo ele poderá ser utilizado nas notificações que precisem deste tipo de conteúdo.

Ficha técnica

Documentação do recurso da API

Files (PUT) /files/{entity_id}/{file_id}

URL

PUT https://api.notifier.datanuvem.ai/v1/files/{entity_id}/{file_id}

Parâmetros de URL

Parâmetro Finalidade
entity_id Código da clínica, consultório, ou hospital cadastrado na API.
file_id ID do arquivo.

Exige autenticação

Sim

Dados a serem enviados

{
  "from_url": "https://drive.google.com/uc?export=download&id=1CC2Da2AZbeacZEq2YMrMmHgyXd1btgw5",
  "description": "Preparação para exame cardiológico",
  "file_ext": "pdf",
  "content": [
    "Não usar cremes na pele do tórax antes do procedimento.",
    "Se você é portador de marca-passo, trazer a carteirinha de identificação do aparelho."
  ]
}
Campo Finalidade
from_url A URL de onde o arquivo será baixado para o armazenamento da API. A URL tem de começar com https://
description Descrição da finalidade do arquivo.
file_ext A extensão/tipo do arquivo. No momento apenas arquivos do tipo pdf são aceitos.
content Um array de strings com um resumo do conteúdo.

O campo content será usado nos canais de comunicação onde não é possível o uso de um arquivo, no canal de voz, por exemplo.

Dados que serão retornados

Em caso de sucesso, status HTTP = 200
{
  "from_url": "https://drive.google.com/uc?export=download&id=1CC2Da2AZbeacZEq2YMrMmHgyXd1btgw5",
  "language": "pt_BR",
  "content": [
    "Não usar cremes na pele do tórax antes do procedimento.",
    "Se você é portador de marca-passo, trazer a carteirinha de identificação do aparelho."
  ],
  "description": "Preparação para exame cardiológico",
  "active": true,
  "file_ext": "pdf",
  "url": "https://portal.rute.ai/s/eCJoA9ggCZsMraC",
  "id": "cjzvqbyku000001js0n5dyr5i"
}

Para verificar se o arquivo foi criado corretamente acesse no seu navegador o endereço que está no campo url. Para documentação adicional sobre os demais possíveis retornos da chamada veja a documentação completa da API em Files (PUT) /files.

Exemplos

Curl
curl -X PUT "https://api.notifier.datanuvem.ai/v1/files/cjth5ux7n000001l1zmd7tk99/cjzvqbyku000001js0n5dyr5i" -H "accept: application/json" -H "Authorization: Bearer <COLOQUE AQUI O TOKEN DE AUTENTICAÇAO>" -H "Content-Type: application/json" -d "{ \"from_url\": \"https://drive.google.com/uc?export=download&id=1CC2Da2AZbeacZEq2YMrMmHgyXd1btgw5\" \"description\": \"Preparação para exame cardiológico\", \"file_ext\": \"pdf\", \"content\": [ \"Não usar cremes na pele do tórax antes do procedimento.\", \"Se você é portador de marca-passo, trazer a carteirinha de identificação do aparelho.\" ]}"

Informação

Para saber quais os arquivos que já estão cadastrados para uma entidade use está API Files (GET) /files/{entity_id}.