Metni Vurgula
PDF → Metni Vurgula
Bu uç nokta şunlarla eşleşiyor: Öne çıkanlar Postacı koleksiyonu: POST /api/v2/HighlightText vücutla document, docContent, Ve textHighlightingAction (Postman'ın ham sürümündekiyle aynı tuşlar ve iç içe geçme yapısı) JSON).
Highlight Text API'yi deneyin
:::not Hızlı referans
Yol: POST /api/v2/HighlightText (Postacı: https://api.pdf4me.com/api/v2/HighlightText) · Gövde tuşları: document, docContent, textHighlightingAction · Başlıklar: Content-Type: application/json, Authorization: Basic <api-key>
:::
:::bilgi Canlı olarak deneyin
-
belge: JSON nesne ile
Name(başkent N), örneğin{ "Name": "Thiscar.pdf" }Sahayı terk edin. boş (Tüm metni silin) Eğer istemiyorsanızdocumenttüm mülkler. -
belge içeriği: PDF gibi Base64 (Bir dosya yükleyin). Gerçek bir çalıştırma için boş olmamalıdır (Postman ile aynı).
-
metinVurgulamaEylemi: JSON nesne ile
TextHighlightList: bir dizi{ "Text": "…", "HighlightColor": "#RRGGBB" }.:::
Postman ile aynı yapıya sahip (ham gövde).
Dışa aktardığınız koleksiyon tam olarak şu üst düzey özellikleri kullanır:
{
"document": {
"Name": "Thiscar.pdf"
},
"docContent": "<base64: from Postman or from file upload here>",
"textHighlightingAction": {
"TextHighlightList": [
{ "Text": "Welcome", "HighlightColor": "#FF2C00" },
{ "Text": "promise", "HighlightColor": "#00FF00" }
]
}
}
Orada HAYIR docName, async, veya IsAsync Bu koleksiyonda yalnızca yukarıdaki üç anahtar ve kimlik doğrulama başlıkları bulunur.
Eğer görürseniz 400: "Invalid File"
Bu yanıt şuradan geliyor: API ne zaman Dosya baytları kabul edilmiyor. (ne zaman değil) JSON (Tuşlar yanlış). Tipik nedenler:
- Gerçek bir PDF değil.Eylemin beklentisi şudur: PDFWord dosyaları, resimler veya boş içerik göndermeyin. Bkz. Dosya Boş / Geçersiz Dosya.
document.Namevs dosyası: Kullanmakdocument.Nameile aynı temel dosya adı olarak PDF kodladığınız (dahil).pdf(örneğin, bir şey yüklerseniz)invoice.pdf, kullanmak{ "Name": "invoice.pdf" }Uyumsuzluk, bazı ortamlarda doğrulama hatalarına yol açabilir.- Base64 başka yerden yapıştırıldı: Kaldırmak satır sonları içinde Base64 dizeyi dahil etmeyin
data:application/pdf;base64,Alanın içine önek ekleyin (test cihazı gönderirken her ikisini de kaldırır, ancak bozuk veya eksik bir yapıştırma yine de başarısız olur). - Yapıştırmak yerine yükleyin: Kullanmak Dosya Yükle Açık belge içeriği Dolayısıyla kodlama tek bir sürekli işlemdir. Base64 sicim.
Diğer 400 neden
- JSON: Sondaki virgül yok; metinVurgulamaEylemi boş olmayan bir değer içermelidir MetinVurgulamaListesi.
- ÇevrePostacı şunu kullanabilir:
api.pdf4me.comBelge test uzmanı şunları kullanabilir:api-dev.pdf4me.comveya bir vekil, JSON Vücut ölçüleri yine de uyumlu olmalı.
Genel Bakış, Parametreler ve Kullanım Örnekleri
- Overview
- Parameters
- Use cases
Alan → JSON eşlemesi
Her bir gövde parametre adı şudur: JSON anahtar: document, docContent, textHighlightingActionaynı şekilde Bul ve Değiştir Stil test uzmanları.
Postacı eşitliği
İçe aktarmak Highlight.postman_collection ve karşılaştırın çiğ vücut ile cURL Test cihazında önizleme yapın, aynı dosyayı yükledikten sonra eşleşmeleri gerekir. PDF.
| Parametre | İçinde JSON |
|---|---|
| belge | Object ile Name (İsteğe bağlı; alanı temizleyerek atlayabilirsiniz). |
| belge içeriği | Base64 sicim. |
| metinVurgulamaEylemi | { "TextHighlightList": [ … ] }. |
- Tek bir aramada birden fazla renkli vurgu.
- Tekrar kullanın metinVurgulamaEylemi Postman'den kopyalanan blok.
:::bilgi API katalog PDF4me API dokümantasyon :::
Önkoşullar
- PDF4me API anahtar (Alın API Anahtar)
- A PDF dosya
Yanıt formatı
Genellikle vurgulanmış bir PDF (ikili veya JSON ile belge içeriği).