Belgeyi Bölme - Belge Bölümleme API
PDF4me Belgeyi Bölünmüş Bu özellik, Word belgelerini esnek bölme seçenekleri ve kapsamlı yapılandırma kontrolüyle birden fazla küçük belgeye bölmenizi sağlar. API Bu hizmet, Word dosyalarını işler ve bunları sayfalara, bölümlere, başlıklara veya özel sayfa aralıklarına göre böler; bölme kriterleri, belge adlandırması ve çıktı organizasyonu üzerinde tam kontrol sağlar. API Word belgesi içeriğini şu yolla alır: REST API aramalar, kullanarak Base64 Güvenli iletim için kodlama. Sayfa bazlı bölme, bölüm bazlı ayırma, başlık bazlı ayırma ve özel sayfa aralıkları desteğiyle bu çözüm, belge yönetimi, içerik dağıtımı ve iş akışı otomasyonu için idealdir.
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
- Çoklu Bölme TürleriSayfalara, bölümlere, başlıklara veya özel aralıklara göre bölün
- Sayfa Aralığı Desteği: Belirli sayfa numaralarına veya aralıklarına göre bölme
- Bölüm Bazlı BölmeHer Word bölümünden sonra belgeyi ikiye bölün.
- Başlık Bazlı BölümlemeBelirtilen stildeki her başlığın ardından belgeyi ikiye bölün (örneğin, Başlık 1, Başlık 2).
- Esnek Yapılandırma: splitConfig parametresiyle özel bölme kriterleri
- Benzersiz Belge AdlarıBölünmüş her belgeye benzersiz bir GUID dosya adı atanır.
- Biçim KorumaOrijinal belge biçimlendirmesini ve yapısını korur.
- Kültür Desteği: Bölgeye özgü belge işleme
REST API Uç nokta
O PDF4me REST API standart kullanır HTTP Kaynaklarla etkileşim kurma yöntemleri. Tüm belge bölme işlemleri tek bir uç nokta üzerinden gerçekleştirilir:
- Yöntem: POST
- Uç nokta:
office/ApiV2Word/SplitDocument
REST API Parametreler
Bölünmüş Belge için parametrelerin 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.
splitConfigparametre şu durumlarda gereklidir:splitType"Dizi", "sayfa sayısı" veya "başlıklar"dır.
Gerekli Parametreler
| Parametre | Tip | Tanım | Örnek |
|---|---|---|---|
| belge* | Object | Belge referansı. İçermelidir. İsim (string): .docx uzantılı Word dosya adı. Referans ve işleme amacıyla kullanılır. | { "Name": "document.docx" } |
| belge içeriği* | Base64 | Word belgesinin içeriği kodlanmıştır. Base64Belge, belirtilen kriterlere göre bölünür. Geçerli bir Word belgesi olmalıdır (.docx, .doc formatları). | base64EncodedDocumentContent |
İsteğe bağlı parametreler
| Parametre | Tip | Tanım | Örnek |
|---|---|---|---|
| bölünmüşTürü | String | Belge bölme türü. Seçenekler: allpages - Ayrı sayfalara bölünmüş (varsayılan), array - Belirli sayfa aralıklarına göre bölünmüştür (örneğin "1-3,4,5-7"), numberofpages - Her N sayfada bir bölme işlemi (yapılandırma: "3" veya "5" gibi pozitif bir tamsayı), section - Belgeyi her bölümden sonra ikiye ayırın, headings - Belirtilen stilin her başlığından sonra belgeyi bölün (örneğin, "Başlık 1"). Bölünmüş her belgeye benzersiz bir kimlik atanır. GUID dosya adı | "allpages" |
| bölünmüş yapılandırma | String | Bölme işlemi için yapılandırma. Dizi içinSayfa aralıkları "1-3,4,5-7" (sayfa 1-3, sayfa 4, sayfa 5-7) veya tek sayfalar "1,3,5" şeklinde olabilir. Sayfa sayısı için: "3" veya "5" gibi pozitif bir tamsayı: her N sayfada bir bölme işlemi yapar. Başlıklar içinBaşlık stili adı, örneğin "Başlık 1" veya "Başlık 2". splitType "array", "numberofpages" veya "headings" olduğunda gereklidir. Sayfa numaraları 1'den başlar. Başlık eşleştirmesi büyük/küçük harf duyarlı değildir. | "1-3,4,5-7" veya "3" veya "Heading 1" |
| kültürAdı | String | Belge işleme için kültür kodu (örneğin, "en-US", "de-DE", "fr-FR"). Varsayılan: "en-US". Belge dilini ve biçimlendirmesini etkiler. Meta veri ve yerelleştirme işlemleri için kullanılır. | en-US |
Bölme Tipi Seçenekleri
O API Belge bölme işlemleri için farklı bölme türleri sunar:
| Bölünmüş Tip | Tanım | SplitConfig gerektirir. | Kullanım Durumu |
|---|---|---|---|
| allpages | Ayrı sayfalara bölünmüş (varsayılan) | HAYIR | Her sayfayı ayrı bir belge olarak çıkarın. |
| array | Sayfa aralıkları belirtilerek bölünür. Virgülle ayrılmış her aralık bir belge haline gelir (örneğin "1-3,4,5-7" → 3 belge). | Evet | Belirli sayfa aralıklarından veya tek sayfalardan belge oluşturun. |
| numberofpages | Her N sayfada bir bölünür. Bölme işlemi ardışık olarak yapılır: her N sayfa bir belge oluşturur; kalan kısım son belgedir. | Evet | Eşit büyüklükte parçalara bölün (örneğin her 3 veya 5 sayfada bir). |
| section | Her Word bölümünden sonra belgeyi bölün. | HAYIR | Bölüm başına bir belge |
| headings | Belirtilen stildeki her başlığın ardından belgeyi bölün (örneğin, "Başlık 1"). | Evet | Başlık düzeyine göre bölümleri veya kısımları çıkarın. |
Bölünmüş Yapılandırma Örnekleri
Bölme yapılandırmasını anlamak, belge bölme iş akışlarınızı optimize etmenize yardımcı olur:
array: açık sayfa aralıkları
"1-3,4,5-7"→ 3 belge: sayfalar 1-3, sayfa 4, sayfalar 5-7"1,3,5"→ 3 belge: sayfa 1, sayfa 3, sayfa 5"1-5,6-10"→ 2 belge: sayfalar 1-5, sayfalar 6-10
numberofpages: her N sayfadan sonra bölün
Davranış: Her N sayfada bir ardışık olarak bölünür.
Yapılandırma: Gerekli, format tek bir pozitif tam sayı olmalıdır (örneğin, "3", "5").
Örnekler:
- Yapılandırma
"3"10 sayfalık bir belgede → 4 belge: Belge 1: 1-3. sayfalar, Belge 2: 4-6. sayfalar, Belge 3: 7-9. sayfalar, Belge 4: 10. sayfa - Yapılandırma
"5"12 sayfalık bir belgede → 3 belge: Belge 1: 1-5. sayfalar, Belge 2: 6-10. sayfalar, Belge 3: 11-12. sayfalar
headings: her başlıktan sonra bölün
"Heading 1"Her blokta bir belge bulunur ve bu belge bir sonraki Başlık 1'de (veya belgenin sonunda) sona erer."Heading 2"Her blokta bir belge bulunur ve bu belge bir sonraki Başlık 2'de (veya belgenin sonunda) sona erer.- Büyük/küçük harf duyarlılığı olmayan eşleştirme
section
Herhangi bir yapılandırma gerekmez. Belge, her Word bölüm sonundan sonra bölünür; her bölüm tek bir belge haline gelir.
Çıktı
O PDF4me Belgeyi Bölünmüş REST API Bölme sonucunu şu şekilde döndürür: JSON. O API Yanıt olarak standart yanıt alanlarıyla birlikte tek bir belge (ilk bölünmüş belge) döndürür.
- Success Response
- Asynchronous Processing
- Error Responses
- Response Format Details
Senkron İşleme (Varsayılan)
O API İsteği işler ve ilk bölünmüş belgeyi döndürür:
Durum Kodu: 200 OK
İçerik Türü: application/json
Yanıt Metni:
{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "a1b2c3d4-e5f6-7890-abcd-ef1234567890.docx",
"success": true,
"errorMessage": null
}
Yanıt Alanları:
- belge (string): Bölünmüş belgenin ilk içeriği, şu şekilde kodlanmıştır: Base64 sicim
- dosya adı (string): Bölünmüş belge için oluşturulan dosya adı (GUID-temelli)
- başarı (boolean): İsteğin başarılı olup olmadığını gösterir.
- hataMesajı (string veya boş): Başarı başarısız olduğunda hata ayrıntıları
Kullanım Talimatları:
- Çıkarın
documenttarladan JSON cevap (Base64) - Şifreyi çöz Base64 Word belgesinin ikili verilerini elde etmek için kullanılan dize
- Kullanın
fileNameBölünmüş belgeyi kaydetmek için
Örnek (JavaScript):
const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save with data.fileName or custom name
Asenkron İşleme
Asenkron davranış (202) Accepted (Yoklama ile birlikte) bu özellik, istek gövdesi parametresiyle değil, sunucu yapılandırmasıyla kontrol edilir. Etkinleştirildiğinde, API yoklama işlemiyle 202 durum kodu döndürebilir. URL içinde Location başlık. Sorgula URL ile GET 200 talep alana kadar OK Aynı yanıt biçimiyle (belge, dosya adı, başarı, hata mesajı).
Hata Yanıtları
O API standart iadeler HTTP Hata kodları ve hata detayları:
- Geçersiz istek parametreleri
- Gerekli alanlar eksik (
belgeileİsim,belge içeriği) - Geçersiz bölme yapılandırması sağlandı.
bölünmüş yapılandırmagerektiğindebölünmüşTürü"dizi", "sayfa sayısı" veya "başlıklar"dır.- Geçersiz Base64 kodlamada
belge içeriği - Geçersiz veya bozuk Word belgesi
- Belgede başlık bulunamadı (başlık tabanlı bölme için).
- Geçersiz sayfa aralığı belirtildi (sayfa numaraları belge sayfa sayısını aşıyor)
- Geçersiz bölme türü
- 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ı
- Word belgesi işleme hatası
- Belgeyi bölme işleminde hata oluştu.
- Bytes'tan belge yüklenirken hata oluştu.
- Belgeyi bayta dönüştürürken hata oluştu.
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 JSON Belge dizisiyle, asla doğrudan ikili Word verisiyle değil.
Yanıt Yapısı:
{
"document": "string", // Base64-encoded Word document content (first split)
"fileName": "string", // GUID-based filename (e.g., "a1b2c3d4-e5f6-7890-abcd-ef1234567890.docx")
"success": true,
"errorMessage": "string or null"
}
İçerik Türü Başlığı:
- Başarı:
application/json - Bölünmüş belge şu şekilde yerleştirilir: 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 Word Belgesine:
JavaScript/Node.js:
const base64 = response.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js
// Save with response.fileName or custom name
Python:
import base64
response_data = response.json()
word_bytes = base64.b64decode(response_data['document'])
filename = response_data['fileName']
with open(filename, 'wb') as f:
f.write(word_bytes)
C#:
byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes(response.fileName, wordBytes);
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 (Tüm Sayfaları Böl - Varsayılan):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "allpages"
}
Sayfa Aralığı Örneği (dizi):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "array",
"splitConfig": "1-3,4,5-7"
}
Her N sayfadan sonra bölme örneği (sayfa sayısı):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "numberofpages",
"splitConfig": "3"
}
Başlık Bazlı Örnek (her başlıktan sonra bölme):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "headings",
"splitConfig": "Heading 1",
"cultureName": "en-US"
}
Bölüm Bazlı Örnek (her bölümden sonra bölünmüştür):
{
"document": { "Name": "document.docx" },
"docContent": "base64EncodedDocumentContent",
"splitType": "section",
"cultureName": "en-US"
}
Kod Örnekleri
O PDF4me Belgeyi Bölünmüş 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
- Sözleşme YönetimiÇok taraflı sözleşmeleri ayrı bölümlere ayırın
- Dava BelgeleriDosyalardan belirli sayfaları ayıklamak
- Uyumluluk Raporlarıİlgili bölümleri farklı departmanlara dağıtın.
- Hukuk AraştırmasıBüyük hukuk belgelerini konu veya bölüme göre ayırın.
İşletme ve Kurumsal Kullanım Senaryoları
- Rapor DağıtımıRaporları farklı paydaşlar için bölümlere ayırın.
- Teklif Yönetimi: Müşteriye özel teslimatlar için bölümleri ayıklayın
- İç DokümantasyonKılavuzları konu veya bölüme göre ayırın.
- Arşiv OrganizasyonuDepolama ve erişim için mantıksal belge parçaları oluşturun.
Eğitim ve Araştırma Kullanım Örnekleri
- Müfredat MateryalleriDers kitaplarını ayrı ayrı bölümlere ayırın.
- Öğrenci Kayıtları: Farklı akademik bölümler için belirli sayfaları çıkarın
- Araştırma Makaleleri: Büyük makaleleri hakem değerlendirmesi için bölümlere ayırın.
- Tıbbi ve Araştırma DokümantasyonuAraştırma veya klinik belgeleri metodolojiye veya bölüme göre ayırın.
Finans ve Bankacılık Kullanım Örnekleri
- Finansal Raporlar: Belirli bölümleri farklı paydaşlara dağıtın
- Denetim DokümantasyonuFarklı denetim alanları için ilgili sayfaları ayıklayın.
- Mevzuat UyumluluğuUyumluluk belgelerini düzenleme türüne göre ayırın.
- Risk değerlendirmesiRisk bölümlerini ilgili ekiplere dağıtın.