PDF'ye Form Alanları Ekleme - Etkileşimli Form API'si
PDF4me PDF'ye Form Alanları Ekle Bu sayede etkileşimli form alanları ekleyebilirsiniz. PDF Belgeler. Bu API hizmet süreçleri PDF Dosyaları düzenler ve belirtilen sayfalardaki belirli konumlara form alanları (metin kutuları ve onay kutuları) ekler. API alır PDF içerik ve form alanı parametreleri aracılığıyla REST API aramalar, kullanarak Base64 Güvenli iletim için kodlama. Esnek konumlandırma, özel alan türleri ve sayfa hedefleme desteğiyle bu çözüm, belge otomasyonu ve etkileşimli uygulamalar için idealdir. PDF geliştirme iş akışları.
API İsteğinizin Kimlik Doğrulaması
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
- Form Alanı TürleriForm alanlarına TextBox ve CheckBox alanlarını ekleyin. PDF belgeler
- Hassas KonumlandırmaAlan yerleşimini tam X ve Y koordinatlarıyla kontrol edin.
- Özel Alan BoyutlandırmaForm alanı boyutlarını tasarım gereksinimlerine uyacak şekilde ayarlayın.
- Esnek Sayfa HedeflemeForm alanlarını belirli sayfalara veya tüm belgelere uygulayın.
- Başlangıç DeğerleriForm alanları için varsayılan değerler belirleyin.
- Base64 Kodlama: Güvenli dosya içeriği iletimi kullanarak Base64 kodlama
- Basit API Entegrasyon: Huzurlu API otomatikleştirme için tasarlanmıştır PDF Form oluşturma iş akışları
REST API Uç Noktası
O PDF4me REST API standart kullanır HTTP Kaynaklarla etkileşim kurma yöntemleri. Tüm form alanı ekleme işlemleri tek bir uç nokta üzerinden gerçekleştirilir:
- Yöntem: POST
- Uç nokta:
/api/v2/AddFormField
REST API Parametreleri
PDF'ye Form Alanları Ekleme işlevinin parametrelerinin tam listesi 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 içeriği* | Base64 | Girişin içeriği PDF dosya şu şekilde kodlanmıştır: Base64 | JVBERi... |
| belge adı* | String | Kaynak PDF .pdf uzantılı dosya adı | output.pdf |
| başlangıç değeri* | String | Form alanı için başlangıç değeri | New input text |
| pozisyonX* | Integer | X, form alanının sayfadaki konumu. | 300 |
| pozisyonY* | Integer | Form alanının sayfadaki Y konumu | 300 |
| alanAdı* | String | Form alanının adı | Input Field Name |
| Boyut* | Integer | Form alanının boyutu | 4 |
| sayfalar* | String | Sayfa seçenekleri: 1. sayfa için "1", belirli sayfalar için "1,3,5", sayfa aralığı için "2-5", karışık sayfalar için "1,3,7-10", 1. sayfadan son sayfaya kadar olan sayfalar için "1-". | 1 |
| formAlanTürü* | String | Form alanı türü: Metin Kutusu veya Onay Kutusu | TextBox |
İsteğe bağlı parametreler
| Parametre | Tip | Tanım | Örnek |
|---|---|---|---|
| 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 Konum başlığında | true |
Çıktı
O PDF4me PDF'ye Form Alanları Ekle REST API İşleme moduna bağlı olarak farklı yanıtlar döndürür. API geri döner PDF gibi ikili veri senkron işleme için veya yoklama sağlar URL Asenkron işlem için.
- 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
İçerik Türü: application/pdf veya application/octet-stream
Yanıt Metni:
O API geri döner PDF dosyayı doğrudan ikili veri olarak (değil) JSON).
Kullanım Talimatları:
- Yanıt gövdesi ikili veriyi içerir. PDF veri
- Yanıt içeriğini doğrudan şu şekilde kaydedin: PDF dosya
- HAYIR Base64 İkili yanıtlar için kod çözme gereklidir.
Örnek (JavaScript):
const response = await fetch(url, options);
const pdfBlob = await response.blob();
// Save or process pdfBlob directly
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/AddFormField/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 ikili veriyi içerir. PDF veri
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 pdfBlob = await pollResponse.blob();
// Process binary PDF
break;
}
await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}
Hata Yanıtları
| Durum Kodu | Tanım | Örnek Yanıt |
|---|---|---|
| 400 Bad Request | Geçersiz istek parametreleri veya eksik gerekli alanlar | {"error": "Missing required parameter: fieldName"} |
| 401 Unauthorized | Geçersiz veya eksik API anahtar | {"error": "Unauthorized"} |
| 500 Internal Server Error | İşlem sırasında sunucu hatası oluştu. | {"error": "Internal server error"} |
Yanıtı Anlamak
- Senkron (200): İkili değer döndürür PDF veriler doğrudan
- Asenkron (202)Sorgulama için Location başlığını döndürür, nihai yanıt ikili değerdir. PDF
- HAYIR JSON Sarmalayıcı: The API iadeler PDF ikili veri olarak, sarılmamış halde JSON ile Base64 kodlama
Talep Örneği
Başlık
Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY
Not: O API anahtar olmalı Base64 Kodlanmış. Alın API anahtardan PDF4me Kontrol Paneli
Yük
{
"docContent": "Please put PDF base64 content",
"docName": "output.pdf",
"initialValue": "input text",
"positionX": 300,
"positionY": 300,
"fieldName": "Input Field Name",
"Size": 4,
"pages": "1",
"formFieldType": "TextBox"
}
Kod Örnekleri
O PDF4me PDF'ye Form Alanları Ekle 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 Apps Script Örnek
Google Apps Script uygulama için Google Workspace entegrasyon:
Form Alanı Oluşturma Özellikleri
Form Alanı Türleri
- Metin Kutusu AlanlarıKullanıcı veri girişi ve form doldurma için metin giriş alanları oluşturun.
- Onay Kutusu AlanlarıSeçim ve onay seçenekleri için onay kutusu öğeleri ekleyin.
- Özel BoyutlandırmaAlan boyutlarını tasarım gereksinimlerine ve içerik ihtiyaçlarına uyacak şekilde ayarlayın.
- Profesyonel SonuçlarYüksek kaliteli ve doğru işlevselliğe sahip form alanı oluşturma
- Gelişmiş İşlemeKarmaşık form düzenleri ve alan düzenlemeleri için destek
Konumlandırma ve Yerleşim
- Kesin KoordinatlarAlan yerleşimini tam X ve Y konum değerleriyle kontrol edin.
- Esnek KonumlandırmaSayfa konumu ve alan düzenlemesi konusunda her türlü desteği sağlar.
- Sayfa HedeflemeForm alanlarını belirli sayfalara veya tüm belgelere uygulayın.
- Özel Boyutlandırma: Optimum form tasarımı için ayarlanabilir alan boyutları
- Profesyonel DüzenlemeHedef sayfaların tümünde form alanlarının tutarlı şekilde yerleştirilmesi.
Gelişmiş Özellikler
- Başlangıç DeğerleriKullanıcı deneyimini iyileştirmek için varsayılan alan değerlerini ayarlayın.
- Alan AdlandırmasıForm verisi toplama ve işleme için özel alan adları
- Profesyonel YaratımYüksek kaliteli ve net işlevselliğe sahip form alanı oluşturma
- Esnek Seçenekler: Belirli gereksinimler için özelleştirilebilir form alanı parametreleri
Sektör Kullanım Örnekleri ve Uygulamaları
- Legal & Professional Services
- Healthcare & Medical
- Finance & Banking
- Human Resources
- Business & Enterprise
Hukuk ve Profesyonel Hizmetler Kullanım Örnekleri
- Sözleşme FormlarıSözleşmelere ve anlaşmalara dijital imza için form alanları ekleyin.
- Yasal BelgelerHukuki belge işleme için etkileşimli formlar oluşturun.
- Uyumluluk FormlarıMevzuat uyumluluğu ve dokümantasyon için formlar oluşturun.
- Müşteri KabulüHukuk hizmetleri için müşteri kayıt formları oluşturun.
Sağlık ve Tıbbi Kullanım Alanları
- Hasta FormlarıEtkileşimli hasta kayıt ve tıbbi geçmiş formları oluşturun
- Tıbbi BelgelerTıbbi kayıtlar ve dokümantasyon için formlar oluşturun.
- Sigorta TalepleriSigorta hasar işlemleri için formlar tasarlayın.
- Onay FormlarıTıbbi işlemler için onay ve yetkilendirme formları oluşturun.
Finans ve Bankacılık Kullanım Örnekleri
- Finansal UygulamalarKredi ve borç başvuru formları oluşturun
- Hesap AçmaHesap açma ve KYC süreçleri için formlar oluşturun.
- İşlem FormlarıFinansal işlemler ve süreçler için formlar tasarlayın.
- Uyumluluk BelgeleriMevzuata uyumluluk raporlaması için formlar oluşturun.
İnsan Kaynakları Kullanım Örnekleri
- Başvuru İşlemeİş başvuruları ve kayıtlar için başvuru formları oluşturun.
- Çalışan OryantasyonuÇalışanların işe alım ve dokümantasyon süreçleri için formlar oluşturun.
- Anket OluşturmaEtkileşimli anketler ve soru formları tasarlayın PDF format
- Performans DeğerlendirmeleriPerformans değerlendirme ve geri bildirim için formlar oluşturun.
İşletme ve Kurumsal Kullanım Senaryoları
- Belge OtomasyonuVeri toplama ve işleme için etkileşimli formlar oluşturun.
- Veri ToplamaMüşteri bilgilerini ve geri bildirimlerini toplamak için formlar oluşturun.
- Etkileşimli BelgelerMevcut formlara yeni form alanları ekleyin. PDFs kullanıcı etkileşimini artırmak için
- İş Süreç OtomasyonuOtomatik iş akışları ve veri girişi için formlar oluşturun.