Eklemek HTML Başlık Altbilgisi PDF - Markalaşma API
PDF4me Eklemek HTML Başlık Altbilgisi PDF eklemenizi sağlar HTML İçeriği başlık, altbilgi veya her ikisi olarak kullanmak için PDF Belgeler. Bu API hizmet süreçleri PDF dosyalar ve ekler HTML Belge markalaması ve organizasyonu için hassas konumlandırma, özel kenar boşlukları ve sayfa hedefleme seçenekleriyle içerik. API alır PDF içerik ve HTML veri yoluyla REST API aramalar, kullanarak Base64 güvenli kodlama PDF İletim desteğiyle. HTML İçerik, esnek konumlandırma, özel kenar boşlukları, sayfa hedefleme ve ilk sayfa hariç tutma özellikleriyle bu çözüm, belge markalaması, rapor oluşturma ve kurumsal uygulamalar için idealdir. PDF iş akışları.
Kimliğinizi Doğrulama API Rica etmek
Erişmek için PDF4me REST APIHer istek, geçerli kimlik doğrulama bilgilerini içermelidir. Kimlik doğrulama, güvenli iletişimi sağlar ve yetkili bir kullanıcı olarak kimliğinizi doğrular. REST API.
Başlıca Özellikler
- HTML İçerik DesteğiZengin içerik ekle HTML Başlık ve altbilgi olarak içerik, tam stil desteğiyle birlikte.
- Esnek KonumlandırmaBaşlık ve altbilgi yerleşimini hassas kenar boşluğu kontrolüyle yönetin.
- Özel Stil: Tam dolu HTML Ve CSS profesyonel görünüm için destek
- Sayfa Hedefleme: Belirli sayfalara veya tüm belgelere üstbilgi ve altbilgi uygulayın.
- İlk Sayfayı Atlaİlk sayfadan üstbilgi ve altbilgileri hariç tutma seçeneği
- Profesyonel SonuçlarBelge düzenini ve marka kimliğini geliştiren üstbilgiler ve altbilgiler oluşturun.
- Sorunsuz API Entegrasyon: REST API otomatikleştirme için tasarlanmıştır PDF düzenleme iş akışları ve kurumsal sistem entegrasyonu
REST API Uç nokta
O PDF4me REST API standart kullanır HTTP Kaynaklarla etkileşim kurma yöntemleri. Tüm başlık ve altbilgi ekleme işlemleri tek bir uç nokta üzerinden gerçekleştirilir:
- Yöntem: POST
- Uç nokta:
/api/v2/AddHtmlHeaderFooter
Başlık Altbilgi Özellikleri
HTML İçerik Desteği
- HTML İçerik: Desteklemek için HTML satır içi içerik CSS stil
- Özel Stil: Satır içi kullanım CSS yazı tipleri, renkler, hizalama ve temel stillendirme için
- Metin ve Görseller: Desteklemek için HTML metin içeriği ve gömülü resimler
- Ova HTML Sicim: HTML İçerik düz metin dizesi olarak sağlanmalıdır (değil Base64 kodlanmış)
Konumlandırma ve Yerleşim
- Marj KontrolüPiksel tabanlı ölçümlerle hassas konumlandırma (marginLeft, marginRight, marginTop, marginBottom)
- Sayfa Hedefleme: Sayfa seçeneklerini kullanarak belirli sayfalara uygulayın (tüm sayfalar için boş dize, "1", "1,3,5", "2-5", "1,3,7-10", "2-")
- İlk Sayfayı Atlaİlk sayfadan üstbilgi ve altbilgileri hariç tutma seçeneği
- Konum Seçenekleriİçeriği Başlık, Altbilgi veya Her İkisi Olarak Ekleyin
Gelişmiş Özellikler
- Asenkron İşlemeUzun süren işlemler için yoklama yöntemiyle eşzamansız işlemeyi destekleme
- Profesyonel GörünümBelgeler genelinde tutarlı biçimlendirme ve stillendirme
- Esnek KonumlandırmaBaşlık ve altbilgi yerleşimini hassas piksel ölçüleriyle kontrol edin.
REST API Parametreler
Ekle işlemi için parametrelerin tam listesi HTML Başlık Altbilgisi PDF REST APIParametreler, daha iyi anlaşılması ve uygulanması için kategoriye göre düzenlenmiştir.
Önemli: Yıldız (*) ile işaretlenmiş parametreler zorunludur ve mutlaka sağlanmalıdır. API doğru şekilde çalışması için.
Gerekli Parametreler
| Parametre | Tip | Tanım | Örnek |
|---|---|---|---|
| belge adı* | String | Çıktı PDF .pdf uzantılı dosya adı | output.pdf |
| belge içeriği* | Base64 | Girişin içeriği PDF dosya şu şekilde kodlanmıştır: Base64 | JVBERi... |
| htmlİçerik* | String | HTML içerik (düz HTML Başlık veya altbilgi olarak eklenecek metin (base64 kodlaması yapılmamış). | <div style="text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;">Document Header PDF4me</div> |
| konum* | String | Konum için HTML içerik: Başlık, Altbilgi, veya İkisi birden | Header |
İsteğe bağlı parametreler
| Parametre | Tip | Tanım | Örnek |
|---|---|---|---|
| sayfalar | String | Sayfa seçenekleri: tüm sayfalar için boş metin, "1" 1. sayfa için, "1,3,5" belirli sayfalar için, "2-5" sayfa aralığı için, "1,3,7-10" karışık için, "2-" 2. sayfadan son sayfaya kadar | "" veya "1-3" |
| İlk sayfayı atla | Boolean | İlk sayfayı atla (doğru) veya ilk sayfayı dahil et (yanlış) | false |
| sol kenar boşluğu | Çift | Sol kenar boşluğu piksel cinsinden | 20.0 |
| kenar boşluğu | Çift | Sağ kenar boşluğu piksel cinsinden | 20.0 |
| marginTop | Çift | Piksel cinsinden üst kenar boşluğu | 50.0 |
| kenar boşluğu | Çift | Alt kenar boşluğu piksel cinsinden | 50.0 |
| asenkron | Boolean | Asenkron işlemeyi etkinleştirin. true, o API 202 durum kodu döndürür ve bir yoklama işlemi sağlar. URL içinde Location başlık | true |
Önemli Not: O
htmlContentparametre şu olmalıdır: ova HTML sicim, Olumsuz Base64 Kodlanmış. Satır içi olarak ekleyebilirsiniz. CSS stil içinde HTML.
Çıktı
O PDF4me Eklemek HTML Başlık Altbilgisi PDF REST API İşleme moduna bağlı olarak farklı yanıtlar döndürür. API geri döner PDF olarak Base64-kodlanmış dize içinde JSON formatİkili veri olarak değil.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Senkron İşleme (Varsayılan)
Ne zaman async ayarlanmamış veya ayarlanmış false, o API İsteği hemen işleme koyar:
Durum Kodu: 200 OK
Content-Type: application/json
Yanıt Metni:
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg=="
}
Yanıt Alanları:
- belge adı (dize): Çıktı PDF dosya adı
- belge içeriği (dize): The PDF dosya ile HTML Başlık/altbilgi uygulandı, şu şekilde kodlandı: Base64 sicim
Kullanım Talimatları:
- Çıkarın
docContenttarladan JSON cevap - Şifreyi çöz Base64 ikili veriyi elde etmek için kullanılan dize PDF veri
- Kaydet veya işle PDF Dosyayı gerektiği gibi düzenleyin.
Örnek (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const pdfBytes = atob(data.docContent); // Decode Base64
// Save or process pdfBytes
Asenkron İşleme
Ne zaman async: true ayarlanmıştır, API İsteği eşzamansız olarak işler:
Durum Kodu: 202 Accepted
Yanıt Başlıkları:
Location: https://api.pdf4me.com/api/v2/AddHtmlHeaderFooter/poll/12345-abcde-67890
Anket Süreci:
- Çıkarın
Location202 yanıtından gelen başlık - Ankete katılın URL kullanarak GET istekler
- Yanıt alana kadar anket yapmaya devam edin. 200 OK durum
- Son yanıt aynı içeriği içermektedir. JSON format ile
docNameVedocContent(Base64)
Anket Örneği:
// Initial request returns 202 with Location header
const response = await fetch(url, options);
const location = response.headers.get('Location');
// Poll until complete
while (true) {
const pollResponse = await fetch(location, { headers: { 'Authorization': 'Basic ' + apiKey } });
if (pollResponse.status === 200) {
const data = await pollResponse.json();
// Process data.docContent (Base64 PDF)
break;
}
await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}
Hata Yanıtları
O API standart iadeler HTTP Hata kodları ve hata detayları:
- Geçersiz istek parametreleri
- Gerekli alanlar eksik (
belge adı,belge içeriği,htmlİçerik,konum) - Geçersiz Base64 kodlamada
belge içeriği - Geçersiz konum değeri (şunlardan biri olmalı: Başlık, Altbilgi veya Her İkisi)
- Geçersiz HTML içerik
- Geçersiz veya eksik API anahtar
- API anahtar düzgün değil Base64 kodlanmış Authorization başlık
- Eksik
Yetkilendirme: Temelbaşlık
- Sunucu tarafı işlem hatası
- PDF işlem hatası
- HTML oluşturma hatası
Hata Yanıtı Biçimi:
{
"error": "Error message describing what went wrong"
}
Yanıt Biçimi Ayrıntıları
Önemli: O API her zaman geri döner JSONasla ikili değil PDF verileri doğrudan.
Yanıt Yapısı:
{
"docName": "string", // Output PDF filename
"docContent": "string" // Base64-encoded PDF content
}
Content-Type Başlık:
- Başarı:
application/json - O PDF gömülüdür Base64 dize içinde JSON cevap
Neden Base64?
- JSON-ikili veriler için güvenli kodlama
- İletilmesi kolay HTTP
- Tüm programlama dilleriyle uyumludur.
- Doğrudan içine yerleştirilebilir JSON sorunlardan kaçmadan
Kod çözme Base64 ile PDF:
JavaScript/Node.js:
const base64 = response.docContent;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64').toString('binary'); // Node.js
Python:
import base64
pdf_bytes = base64.b64decode(response['docContent'])
with open('output.pdf', 'wb') as f:
f.write(pdf_bytes)
C#:
byte[] pdfBytes = Convert.FromBase64String(response.docContent);
File.WriteAllBytes("output.pdf", pdfBytes);
Talep Örneği
Başlık
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Not:
- Alın API anahtardan PDF4me Kontrol Paneli
- O API anahtar olmalı Base64 "Basic" önekiyle kodlanmış ve ön eklenmiş Authorization başlık
- Örnek: Eğer sizin API anahtar şudur
abc123onu kodla Base64 ve kullanınAuthorization: Basic YWJjMTIz
Yük
Temel Örnek (Sadece Gerekli Alanlar):
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"htmlContent": "<div style='text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;'>Document Header PDF4me</div>",
"location": "Header"
}
Gelişmiş Örnek (Tüm İsteğe Bağlı Alanlarla):
{
"docName": "output.pdf",
"docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
"htmlContent": "<div style='text-align: center; font-family: Arial; font-size: 12px; color: #FF0000;'>Document Header PDF4me</div>",
"location": "Header",
"pages": "",
"skipFirstPage": false,
"marginLeft": 20.0,
"marginRight": 20.0,
"marginTop": 50.0,
"marginBottom": 50.0,
"async": true
}
Önemli: O
htmlContentalan içermelidir ova HTML bir dize olarak, Olumsuz Base64 Kodlanmış. Satır içi olarak kullanabilirsiniz. CSS stil içinde HTML etiketler.
Kod Örnekleri
O PDF4me Eklemek HTML Başlık Altbilgisi PDF REST API Birden fazla programlama dilinde kod örnekleri sunar. Geliştirme ortamınıza en uygun dili seçin:
- C#
- Java
- JavaScript
- Python
- Salesforce
- n8n
- Google Script
- AWS Lambda
Google Script Örnek
Google Apps Script uygulama için Google Workspace entegrasyon:
Sektör Kullanım Örnekleri ve Uygulamaları
- Legal & Professional Services
- Business & Enterprise
- Education & Research
- Finance & Banking
Hukuk ve Profesyonel Hizmetler Kullanım Örnekleri
- Yasal BelgelerHukuki belgelere yasal sorumluluk reddi ve gizlilik bildirimleri ekleyin.
- Sözleşme BaşlıklarıSözleşmelere ve anlaşmalara başlık ve altbilgi ekleyin.
- Uyumluluk BelgeleriBaşlık ve altbilgilere uyumluluk bildirimlerini ekleyin.
- Müşteri DokümantasyonuMüşteri belgelerine profesyonel başlıklar ve alt bilgiler ekleyin.
İşletme ve Kurumsal Kullanım Senaryoları
- Belge MarkalamasıPDF belgelerine şirket logoları, başlıklar ve alt bilgiler ekleyin.
- Rapor OluşturmaOluşturulan raporlara tutarlı başlıklar ve altbilgiler ekleyin.
- İş BelgeleriMarkalı başlık ve altbilgilerle profesyonel görünümü geliştirin.
- Kurumsal Markalaşmaİş belgelerinizde tutarlı başlık ve altbilgiler kullanın.
Eğitim ve Araştırma Kullanım Örnekleri
- Akademik MakalelerAkademik yayınlara sayfa numaraları, üstbilgiler ve altbilgiler ekleyin.
- Araştırma BelgeleriAraştırma makalelerini uygun başlık ve altbilgilerle biçimlendirin.
- Tez BiçimlendirmeTezlere ve doktora tezlerine başlık ve altbilgi ekleyin.
- Eğitim MateryalleriEğitim dokümanlarını başlık ve altbilgilerle zenginleştirin.
Finans ve Bankacılık Kullanım Örnekleri
- Finansal RaporlarFinansal raporlara ve tablolara başlık ve altbilgi ekleyin.
- Fatura BiçimlendirmeFaturalara ve finansal belgelere başlık ve altbilgi ekleyin.
- Uyumluluk BelgeleriBaşlık ve altbilgilere uyumluluk bilgilerini ekleyin.
- Denetim RaporlarıDenetim raporlarına profesyonel başlıklar ve alt bilgiler ekleyin.