1
Suba o arquivo
Uma requisição
multipart/form-data com o arquivo. A resposta traz o objeto que representa esse arquivo.2
Grave o objeto como resposta
Uma chamada de gravação de respostas, passando o objeto recebido como
answer do campo de anexo.answer não anexa nada.
O upload
O upload é uma requisição autenticada, com corpomultipart/form-data e um único campo, chamado file:
Qualquer outra extensão é recusada com
422. A lista é restrita de propósito: o mesmo serviço atende links públicos e links assinados, então não aceita arquivo executável nem marcação.
Resposta
O upload por si só não anexa o arquivo a lugar nenhum. Enquanto o objeto não for gravado como resposta, ele fica solto — só o registro do upload existe no histórico da conta.
Gravar como resposta
A resposta de um campoattachment é sempre uma lista de objetos de arquivo, mesmo quando é um só. Copie o objeto inteiro que veio do upload:
Ao gravar, a plataforma descarta os parâmetros da URL e guarda só o endereço permanente. Na leitura, ela devolve uma URL temporária nova, também de 24 horas. Por isso a
url que você guardar em outro sistema para de funcionar no dia seguinte — leia de novo em vez de armazenar.is_multiple: true na definição dele. Ver Criar e editar formulários pela API.
Arquivos anexados por campo de formulário aparecem também no botão Arquivos do cartão. Ver Conteúdo do projeto.
Quem responde de fora
Quem preenche o formulário sem ter entrado na plataforma não alcança o endpoint acima. Existem dois caminhos, com os mesmos limites de tamanho e extensão e o mesmo campofile:
Na publicação, o upload só funciona enquanto a publicação está no ar e dentro da janela de datas. A resposta de erro depende do motivo:
- Se a publicação não está publicada, ou o token não existe, a resposta é
404. Confira o token e publique o formulário. - Se a publicação está no ar, mas fora da janela de datas, a resposta é
403commessage: "form_is_not_available". Ajuste as datas de início e fim da publicação.
Erros comuns
validation_errors — the file field is required
validation_errors — the file field is required
O campo do
multipart não se chama file, ou a requisição foi enviada como JSON. Envie como multipart/form-data, com o arquivo no campo file.validation_errors — extensão recusada
validation_errors — extensão recusada
A extensão não está na lista. Converta o arquivo antes de subir — um
.zip ou um .svg, por exemplo, não passam.validation_errors — arquivo grande demais
validation_errors — arquivo grande demais
O arquivo passa de 97.650 KB. Envie um arquivo menor. Confira também o limite do seu próprio proxy ou gateway, que costuma ser mais baixo que o da plataforma.
O anexo some depois de um tempo
O anexo some depois de um tempo
A
url é temporária, de 24 horas. Ela não é um endereço fixo: leia as respostas de novo para obter um link válido.Próximos passos
Criar e editar formulários pela API
Como declarar o campo de anexo e o resto da estrutura.
Formulários dinâmicos e o pivot
Onde a resposta é gravada.