Pular para o conteúdo principal
API PDF4meIntegraçõesBase de conhecimentoExtensõesTestador de APIBlog

Texto em destaque

PDF → Texto em destaque

Este ponto final corresponde ao Destaque Coleção do carteiro: POST /api/v2/HighlightText com corpo document, docContent, e textHighlightingAction (mesmas chaves e aninhamento do arquivo bruto do Postman) JSON).

Experimente a API de realce de texto.​

:::nota Referência rápida Caminho: POST /api/v2/HighlightText (Carteiro: https://api.pdf4me.com/api/v2/HighlightText) · Chaves do corpo: document, docContent, textHighlightingAction · Cabeçalhos: Content-Type: application/json, Authorization: Basic <api-key> :::

Experimente ao vivo
  1. documento: JSON objeto com Name (capital N), por exemplo. { "Name": "Thiscar.pdf" }. Saia do campo vazio (apague todo o texto) se você não quiser um document propriedade alguma.
  2. conteúdo do documento: PDF como Base64 (Enviar um arquivo). Deve conter um arquivo não vazio para que a operação seja bem-sucedida (assim como no Postman).
  3. ação de realce de texto: JSON objeto com TextHighlightList: uma matriz de { "Text": "…", "HighlightColor": "#RRGGBB" }.
Loading API Tester...

Mesma estrutura que o carteiro (corpo bruto)​

A sua coleção exportada utiliza exatamente estas propriedades de nível superior:

{
 "document": {
 "Name": "Thiscar.pdf"
 },
 "docContent": "<base64: from Postman or from file upload here>",
 "textHighlightingAction": {
 "TextHighlightList": [
 { "Text": "Welcome", "HighlightColor": "#FF2C00" },
 { "Text": "promise", "HighlightColor": "#00FF00" }
 ]
 }
}

Há não docName, async, ou IsAsync Nessa coleção, apenas as três chaves acima, além dos cabeçalhos de autenticação.

Se você vir 400: "Invalid File"​

Essa resposta vem do API quando o Não são aceitos bytes de arquivo. (não quando) JSON As teclas estão erradas). Causas típicas:

  1. Não é um PDF verdadeiro.A ação espera um PDFNão envie documentos do Word, imagens ou conteúdo vazio. Consulte O arquivo está vazio/é inválido..
  2. document.Name vs arquivo: Usar document.Name com o mesmo nome de arquivo base como o PDF você codificou (incluindo .pdf), por exemplo, se você fizer o upload invoice.pdf, usar { "Name": "invoice.pdf" }Uma incompatibilidade pode contribuir para falhas de validação em alguns ambientes.
  3. Base64 colado de outro lugar: Remove quebras de linha no Base64 string e não inclua um data:application/pdf;base64, prefixo no campo (o testador remove ambos ao enviar, mas uma colagem corrompida ou truncada ainda falha).
  4. Faça o upload em vez de colar.: Usar Carregar arquivo sobre conteúdo do documento portanto, a codificação é um único processo contínuo Base64 corda.

Outras 400 causas​

  • JSON: Sem vírgulas no final; ação de realce de texto deve incluir um não vazio Lista de destaques de texto.
  • AmbienteO carteiro pode usar api.pdf4me.com; o testador de documentos pode usar api-dev.pdf4me.com ou um representante, o JSON O corpo ainda deve corresponder.

Visão geral, parâmetros e casos de uso​

Mapeamento de campo para JSON​

Cada nome de parâmetro do corpo é o JSON chave: document, docContent, textHighlightingAction, igual a Localizar e substituir testadores de estilo.

Paridade do carteiro​

Import Highlight.postman_collection e compare o cru corpo com o cURL Na pré-visualização do testador, os resultados devem ser iguais após o upload. PDF.

Pré-requisitos​

Formato de resposta​

Normalmente um destacado PDF (binário ou JSON com conteúdo do documento).

Obtenha ajuda​

Get Your API KeyAPI DocumentationAPI Tester Home