Enviar um arquivo

POSThttps://carchost.fieldcontrol.com.br/uploads

Primeira etapa para anexar um arquivo: retorna o endpoint e os campos (form) para enviar o arquivo em multipart/form-data. Depois do envio, anexe o arquivo à ordem em Anexar um arquivo à ordem, usando a URL do arquivo enviado em path.

Requer os headers X-Api-Key, User-Agent e Content-Type: application/json. Limite: 1 requisição por segundo (saiba mais).

Requisição

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Corpo da requisição

JSON, enviado com o header Content-Type: application/json.

entityTypestringobrigatório

Onde o arquivo será anexado. Hoje só order.

Valores aceitos: order.Mínimo de 2 caracteres.

entityIdstringobrigatório

Identificador da ordem de serviço.

titlestringobrigatório

Nome do arquivo, com extensão: .pdf, .doc, .docx, .xls, .xlsx, .ppt, .pptx, .jpg, .jpeg, .heic, .webp, .png, .mp4, .avi, .mov, .kml, .txt, .csv, .xml ou .zip.

Mínimo de 2 caracteres.

typestringobrigatório

Tipo MIME do arquivo (ex. application/pdf, image/jpeg, video/mp4).

sizenumberobrigatório

Tamanho em bytes, até 50 MB.

De 0 a 52428800.

Respostas

• 201

  Dados para o envio, válidos por 20 minutos.

• 401

  Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

• 403

  Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

• 422

  Corpo inválido (resourceValidationErr): entityType diferente de order, ordem inválida, extensão ou tipo não aceitos, ou arquivo acima de 50 MB.

• 429

  Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

• 500

  Erro inesperado no servidor.