Lewati ke konten utama
API PDF4meIntegrasiBasis PengetahuanEkstensiPenguji APIBlog

Teks Sorot

PDF → Teks Sorot

Endpoint ini cocok dengan Menyorot Koleksi tukang pos: POST /api/v2/HighlightText dengan tubuh document, docContent, Dan textHighlightingAction (kunci dan penataan yang sama seperti data mentah Postman) JSON).

Cobalah API Sorot Teks.​

:::catatan Referensi cepat Jalur: POST /api/v2/HighlightText (Tukang pos: https://api.pdf4me.com/api/v2/HighlightText) · Tombol utama: document, docContent, textHighlightingAction · Judul: Content-Type: application/json, Authorization: Basic <api-key> :::

Coba langsung
  1. dokumen: JSON objek dengan Name (modal N), misalnya { "Name": "Thiscar.pdf" }Tinggalkan lapangan kosong (hapus semua teks) jika Anda tidak menginginkan document properti sama sekali.
  2. Konten dokumen: PDF sebagai Base64 (Unggah file). Harus berisi file agar dapat dijalankan (sama seperti Postman).
  3. Aksi Penyorotan Teks: JSON objek dengan TextHighlightList: sebuah susunan { "Text": "…", "HighlightColor": "#RRGGBB" }.
Loading API Tester...

Struktur yang sama dengan Postman (badan mentah)​

Koleksi yang Anda ekspor menggunakan properti tingkat atas berikut ini:

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

Ada TIDAK docName, async, atau IsAsync Dalam koleksi tersebut, hanya terdapat tiga kunci di atas ditambah header otentikasi.

Jika Anda melihat 400: "Invalid File"​

Respons itu datang dari API ketika Byte file tidak diterima (bukan saat) JSON (Kuncinya salah). Penyebab umum:

  1. Bukan PDF asliTindakan tersebut mengharapkan sebuah PDFJangan mengirimkan dokumen Word, gambar, atau konten kosong. Lihat Berkas Kosong / Berkas Tidak Valid.
  2. document.Name vs file: Menggunakan document.Name dengan nama file dasar yang sama sebagai PDF Anda mengkodekan (termasuk .pdf), misalnya jika Anda mengunggah invoice.pdf, menggunakan { "Name": "invoice.pdf" }Ketidaksesuaian dapat menyebabkan kegagalan validasi di beberapa lingkungan.
  3. Base64 disalin dari tempat lain: Menghapus jeda baris di dalam Base64 string dan jangan menyertakan a data:application/pdf;base64, awalan di kolom tersebut (penguji menghapus keduanya saat mengirim, tetapi salinan yang rusak atau terpotong tetap gagal).
  4. Unggah, bukan tempel.: Menggunakan Unggah File pada Konten dokumen jadi pengkodean adalah satu proses berkelanjutan Base64 rangkaian.

400 penyebab lainnya​

  • JSONTidak ada koma di akhir baris; Aksi Penyorotan Teks harus menyertakan yang tidak kosong Daftar Sorotan Teks.
  • Lingkungan: Tukang pos mungkin menggunakan api.pdf4me.com; penguji dokumen dapat menggunakan api-dev.pdf4me.com atau perwakilan, JSON Tubuh harus tetap serasi.

Gambaran umum, parameter, dan kasus penggunaan.​

Bidang → Pemetaan JSON​

Setiap nama parameter tubuh adalah JSON kunci: document, docContent, textHighlightingAction, sama seperti Cari dan Ganti penguji gaya.

Kesetaraan tukang pos​

Impor Highlight.postman_collection dan membandingkan mentah tubuh dengan cURL Lihat pratinjau di penguji, seharusnya hasilnya sama setelah Anda mengunggah file yang sama. PDF.

Prasyarat​

Format respons​

Biasanya disorot PDF (biner atau JSON dengan Konten dokumen).

Dapatkan Bantuan​

Get Your API KeyAPI DocumentationAPI Tester Home