API

Marcar um arquivo

Marque um arquivo em um espaço de trabalho Business ou Enterprise e baixe a cópia marcada.

POST/api/v1/mark

Marca um arquivo e devolve a cópia marcada. O corpo é multipart/form-data.

Autenticação

Authorization: Bearer mf_…

Envie este cabeçalho. Não há cookie de sessão. O curl e outros clientes de servidor são aceitos. Um navegador em outro site é recusado.

Parâmetros

NomeTipoObrigatórioDescrição
filefileSimO arquivo a ser marcado. Business e Enterprise aceitam até 100 MB, 500 páginas de PDF e vídeo de até 10 minutos. O tamanho do envio, a duração do vídeo e o número de páginas do PDF seguem o plano do espaço de trabalho.
identifierstringSimDe 1 a 32 caracteres, sem caracteres de controle. É o rótulo que você vê se essa cópia for detectada depois. Ele não é gravado no arquivo como texto legível.

Requisição

curl -X POST https://markedfile.com/api/v1/mark \
  -H "Authorization: Bearer mf_…" \
  -F "file=@contract.pdf" \
  -F "identifier=northwind"

Resposta

{
  "file": "JVBERi0xLjQK…",
  "mime": "application/pdf",
  "name": "contract.pdf",
  "kind": "pdf",
  "layers": [
    {
      "name": "Metadata",
      "detail": "Authenticated workspace reference; the identifier stays on the server",
      "screenshot": "No",
      "crop": "No",
      "reencode": "No"
    }
  ],
  "remaining": 1
}

file são os bytes marcados em base64. mime, name e kind descrevem o download. layers lista as camadas que foram aplicadas. Quando o plano não tem limite de arquivos ativos, remaining é o número de arquivos ativos depois desta marca. Quando tem limite, remaining é quantas marcas novas ainda restam. Business e Enterprise não têm limite de arquivos ativos. É a exclusão de um arquivo que encerra a detecção.

Erros

O texto do campo error no corpo JSON está em inglês.

StatusDescrição
400O arquivo está vazio, ou o identificador está vazio, tem mais de 32 caracteres ou contém um caractere de controle.
401A chave está ausente, foi revogada ou é desconhecida. O corpo JSON inclui "code": "api-key".
403O espaço de trabalho não tem mais um plano Business ou Enterprise ativo (o corpo inclui "code": "enterprise"), ou o navegador enviou uma requisição cross-site ou same-site.
413O arquivo passa do limite de envio do plano, ou o PDF tem mais páginas do que o plano permite.
422Não foi possível processar o arquivo.
429Esta chave marcou mais de 40 arquivos no minuto atual.

Limite de requisições

40 requisições por minuto para esta chave. O contador fica no banco de dados do produto e continua valendo depois de uma reinicialização.