POST api/watermark

Aplica uma marca de água (texto ou imagem) a um ficheiro suportado e devolve o ficheiro final como binário.

Request Information

URI Parameters

None.

Body Parameters

Pedido de watermark contendo: File: conteúdo Base64 e formato do ficheiro.Watermark: configuração do watermark (texto ou imagem).Options: opções adicionais (ex.: metadata, flatten para PDF).MetadataStamp: dados opcionais para carimbo de metadata.

BEWatermark

Name	Description	Type	Additional information
File	Informação do ficheiro a processar, em Base64 e respetivo formato.	BEFile	None.
Watermark	Configuração visual da marca de água a aplicar.	BEWatermarkConfig	None.
Options	Opções adicionais relacionadas com metadata e comportamento do PDF.	BEWatermarkOptions	None.
MetadataStamp	Informação para stamping de metadata invisível no ficheiro final, permitindo auditoria, rastreabilidade e validação de integridade.	BEMetadataStamp	None.

Request Formats

application/json, text/json

Sample:

{
  "File": {
    "ContentBase64": "sample string 1",
    "Format": 0
  },
  "Watermark": {
    "Type": 0,
    "Text": "sample string 1",
    "ImageBase64": "sample string 2",
    "Opacity": 3.1,
    "Rotation": 4,
    "FontSize": 5,
    "Color": "sample string 6",
    "Position": 0,
    "Repeat": true,
    "AddTimestampToWatermark": true,
    "FontFamily": "sample string 9",
    "Bold": true,
    "Italic": true
  },
  "Options": {
    "IncludeMetadata": true,
    "FlattenPdf": true
  },
  "MetadataStamp": {
    "User": "sample string 1",
    "Timestamp": "2026-05-30T13:12:42.9576741-01:00",
    "SourceSystem": "sample string 3",
    "OriginalFileHash": "sample string 4"
  }
}

text/plain

Sample:

{"File":{"ContentBase64":"sample string 1","Format":0},"Watermark":{"Type":0,"Text":"sample string 1","ImageBase64":"sample string 2","Opacity":3.1,"Rotation":4,"FontSize":5,"Color":"sample string 6","Position":0,"Repeat":true,"AddTimestampToWatermark":true,"FontFamily":"sample string 9","Bold":true,"Italic":true},"Options":{"IncludeMetadata":true,"FlattenPdf":true},"MetadataStamp":{"User":"sample string 1","Timestamp":"2026-05-30T13:12:42.9576741-01:00","SourceSystem":"sample string 3","OriginalFileHash":"sample string 4"}}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'BEWatermark'.

Response Information

Resource Description

Resposta HTTP contendo o ficheiro final como binário: 200 OK com .Content-Type ajustado ao formato.Content-Disposition como attachment para download.

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.