Como utilizar o Form Data

O "Form Data" é um recurso para enviar dados complexos e arquivos em aplicações REST. Ele é utilizado principalmente quando há necessidade de enviar múltiplos tipos de dados (como texto, números e arquivos) em uma única requisição, facilitando a integração com APIs que requerem dados em formatos específicos.

Para criar um "Form Data", siga os seguintes passos:

  1. Crie um módulo do tipo REST.

  2. Em seguida, clique em "Nova operação". Preencha os dados de "Informações gerais" e "Parâmetros".

  3. A etapa de configuração da aba "Requisição" é crucial para o Form Data. Clique na aba "Header".

  4. Observe que a plataforma mostra um valor (application/json) automaticamente para a chave "Context-Type". Troque este valor por multipart/form-data.

  1. Em seguida, na aba "Body", os parâmetros devem ser enviados como campos nomeados com seus respectivos valores, sendo diferente do padrão comumente adotado. Esta ação é essencial para que a plataforma possa ler e interpretar os dados corretamente.

O formato a ser utilizado no "Body" é:

key:value:type:filename

Sendo que:

  • key: nome da chave do Form Data.

  • value: valor em texto ou base64.

  • type (opcional): tipo de valor (mime type). Leia mais nas sugestões de leitura no final da página.

  • filename (opcional): nome do arquivo, aplicável quando o valor estiver em base64. As APIs que recebem esse dado utilizam o filename para gerar o arquivo correspondente.

Se optar por usar o filename, é necessário incluir o type.

Entre uma chave e outra é necessário adicionar quebra de linha;

Exemplo de body

Em um cenário onde normalmente enviamos um JSON no body das requisições da plataforma teríamos algo como o exemplo abaixo:

{
  "file": "base64",
  "action": "save",
  "user": "549875414515"
}

Como dito antes, o body no form data funciona de forma diferente onde seguindo os passos da regra de montagem teríamos algo do tipo: 

file: base64
action:save
user:549875414515

A plataforma não trabalha com JSON no form-data

Exemplo de inserção de dados no Body

A plataforma não processa arquivos diretamente. Qualquer arquivo enviado será em uma base64. Essa string será, então, processada pela plataforma, facilitando o envio de arquivos como imagens e documentos.

  1. Finalize as etapas da criação do módulo.

  2. Pronto! Já é possível usar este módulo no seu fluxo de integração.

Sugestões de leitura:

PreviousFlattening: Transformação de dados utilizando JSONataNextEntendendo a recursividade no JSONata

Last updated