Dokumen Aman - Keamanan Dokumen API

PDF4me Dokumen Aman Memungkinkan Anda menambahkan perlindungan kata sandi dan pembatasan keamanan pada dokumen Word dengan kontrol keamanan komprehensif dan pembatasan pengeditan. Ini API Layanan ini memproses file Word dan menerapkan perlindungan kata sandi terbuka, pembatasan pengeditan dokumen, perlindungan baca saja, akses komentar saja, pengeditan kolom formulir, dan pelacakan revisi. API menerima konten dokumen Word melalui REST API panggilan, memanfaatkan Base64 Pengkodean untuk transmisi yang aman. Dengan kendali penuh atas tingkat keamanan dan persyaratan kata sandi, solusi ini ideal untuk dokumen rahasia, pengeditan kolaboratif, dan alur kerja kontrol akses dokumen.

Postingan Blog Terkait

Belum ada postingan blog untuk fitur ini — akan segera hadir.

Sementara itu, jelajahi blog PDF4me untuk menemukan tutorial dan alur kerja di berbagai platform.

Kunjungi blog ini →

Memverifikasi Identitas Anda API Meminta

Untuk mengakses PDF4me REST APISetiap permintaan harus menyertakan kredensial otentikasi yang tepat. Otentikasi memastikan komunikasi yang aman dan memvalidasi identitas Anda sebagai pengguna yang berwenang. REST API.

Get your api Key

Fitur Utama

• Perlindungan Kata SandiTambahkan persyaratan kata sandi untuk membuka dokumen.
• Perlindungan DokumenBatasi kemampuan pengeditan dengan berbagai jenis perlindungan.
• Keamanan Hanya BacaJadikan dokumen hanya dapat dibaca untuk mencegah pengeditan tanpa izin.
• Akses Khusus KomentarHanya komentar yang diizinkan untuk ditambahkan atau dimodifikasi.
• Pengeditan Kolom FormulirBatasi pengeditan hanya pada kolom formulir.
• Pelacakan RevisiHanya izinkan perubahan dan revisi yang dilacak
• Keamanan GabunganTerapkan perlindungan kata sandi dan pembatasan pengeditan.
• Kontrol Akses FleksibelTingkat keamanan yang berbeda untuk berbagai kasus penggunaan.

REST API Titik akhir

Yang PDF4me REST API menggunakan standar HTTP Metode untuk berinteraksi dengan sumber daya. Semua operasi keamanan dokumen dilakukan melalui satu titik akhir:

• Metode: POST
• Titik akhir: office/ApiV2Word/ApplySecurity

REST API Parameter

Daftar lengkap parameter untuk Dokumen Aman REST APIParameter-parameter tersebut diorganisir berdasarkan kategori untuk pemahaman dan implementasi yang lebih baik.

Penting: Parameter yang ditandai dengan tanda bintang (*) wajib diisi. Parameter kata sandi wajib diisi jika opsi keamanan yang sesuai diaktifkan.

Parameter yang Diperlukan

Parameter	Jenis	Keterangan	Contoh
dokumen*	Object	Referensi dokumen. Harus memuat Nama (string): Nama file Word dengan ekstensi .docx	{ "Name": "document.docx" }
Konten dokumen*	Base64	Konten dokumen Word yang dikodekan dalam Base64Pengaturan keamanan diterapkan pada dokumen ini. Harus berupa dokumen Word yang valid (.docx, .doc format)	base64EncodedDocumentContent

Parameter Opsional (Pengaturan Keamanan)

Parameter	Jenis	Keterangan	Contoh
amanSaatTerbuka	String	Aktifkan perlindungan kata sandi untuk membuka dokumen. "yes" = Membutuhkan kata sandi untuk dibuka, "no" = Tidak memerlukan kata sandi untuk membuka (default). Membutuhkan amanSaatKata Sandi Terbuka saat diaktifkan	"yes"
amanSaatKata Sandi Terbuka	String	Kata sandi diperlukan untuk membuka dokumen. Diperlukan saat secureOnOpen adalah "yes"Kata sandi harus kuat (8+ karakter). Sensitif terhadap huruf besar dan kecil.	"SecurePass123!"
Opsi keamanan	Object	Opsi perlindungan dokumen. Properti: Jenis perlindungan (string: NoProtection, ReadOnly, AllowComments, AllowFormFields, AllowRevisions), kata sandi perlindungan (string). Diperlukan ketika protectionType bukan "NoProtection"	{ "protectionType": "ReadOnly", "protectionPassword": "EditPass456!" }

Opsi Jenis Perlindungan

Yang API menyediakan berbagai jenis perlindungan untuk pembatasan pengeditan dokumen:

Jenis Perlindungan	Keterangan	Kasus Penggunaan
NoProtection	Tidak ada batasan pengeditan (default)	Dokumen yang dapat diedit secara bebas
ReadOnly	Dokumen tidak dapat diedit, hanya dapat dilihat.	Dokumen akhir, laporan yang diterbitkan
AllowComments	Hanya komentar yang dapat ditambahkan/diubah.	Alur kerja peninjauan dokumen
AllowFormFields	Hanya kolom formulir yang dapat diedit.	Formulir yang dapat diisi, survei
AllowRevisions	Hanya perubahan/revisi yang dilacak yang diizinkan.	Penyuntingan kolaboratif dengan pelacakan perubahan

Konfigurasi Keamanan

Perlindungan Kata Sandi (Kata Sandi Terbuka)

• Tujuan: Membutuhkan kata sandi untuk membuka dokumen
• Kapan Harus Digunakan: Dokumen rahasia, informasi sensitif
• Persyaratan: secureOnOpenPassword harus disediakan ketika secureOnOpen adalah "yes"
• KekuatanDisarankan 8+ karakter yang terdiri dari alfanumerik dan karakter khusus.

Perlindungan Dokumen (Pembatasan Pengeditan)

• TujuanMembatasi kemampuan pengeditan namun tetap memungkinkan tampilan dokumen.
• Kapan Harus Digunakan: Penyuntingan kolaboratif, distribusi formulir, alur kerja peninjauan
• Persyaratan: securityOptions.protectionPassword harus disediakan ketika securityOptions.protectionType bukan "NoProtection"
• FleksibilitasDapat dikombinasikan dengan kata sandi terbuka untuk keamanan dua lapis.

Keluaran

Yang PDF4me Dokumen Aman REST API Mengembalikan respons yang berbeda berdasarkan mode pemrosesan. API mengembalikan dokumen Word sebagai Base64-string yang dikodekan dalam JSON format, bukan sebagai data biner.

Success Response

Pemrosesan Sinkron (Default)

Yang API Memproses permintaan dan mengembalikan:

Kode Status: 200 OK

Tipe Konten: application/json

Isi Tanggapan:

{
"document": "UEsDBBQABgAIAAAAIQDfpNJsWgEAACAFAAATAAgCW0NvbnRlbnRfVHlwZXNdLnhtbCCiBAIooAAC...",
"fileName": "document.docx",
"success": true,
"errorMessage": null
}

Kolom Respons:

• dokumen (string): Dokumen Word dengan pengaturan keamanan yang diterapkan, dikodekan sebagai Base64 rangkaian
• nama file (string): Nama file Word keluaran
• kesuksesan (boolean): Menunjukkan apakah permintaan berhasil
• pesan kesalahan (string atau null): Detail kesalahan ketika keberhasilan bernilai salah

Cara Penggunaan:

1. Ekstrak document lapangan dari JSON tanggapan (Base64)
2. Uraikan kodenya Base64 string untuk mendapatkan data biner dokumen Word
3. Simpan atau proses file Word sesuai kebutuhan.
4. Dokumen ini akan memerlukan kata sandi saat dibuka di Word berdasarkan pengaturan keamanan.

Contoh (JavaScript):

const response = await fetch(url, options);
const data = await response.json();
const wordBytes = atob(data.document); // Decode Base64
// Save or process wordBytes - document is password protected

Asynchronous Processing

Pemrosesan Asinkron

Perilaku asinkron (202 Accepted (dengan polling) dikendalikan oleh konfigurasi server, bukan oleh parameter body permintaan. Saat diaktifkan, API dapat mengembalikan status 202 dengan polling URL di dalam Location Judul. Jajak pendapat URL dengan GET permintaan hingga Anda menerima 200 OK dengan bentuk respons yang sama (dokumen, nama file, sukses, pesan kesalahan).

Error Responses

Respons Kesalahan

Yang API pengembalian standar HTTP Kode kesalahan beserta detail kesalahannya:

400 Bad Request

• Parameter permintaan tidak valid
• Kolom yang wajib diisi belum terisi (dokumen dengan Nama, Konten dokumen)
• Kata sandi diperlukan saat amanSaatTerbuka adalah "ya" (amanSaatKata Sandi Terbuka)
• Kata sandi perlindungan diperlukan di Opsi keamanan ketika protectionType bukan "NoProtection"
• Tidak sah Base64 pengkodean dalam Konten dokumen
• Dokumen Word tidak valid atau rusak
• Jenis perlindungan tidak valid
• Kata sandi lemah (disarankan kurang dari 8 karakter)

401 Unauthorized

• Tidak valid atau hilang API kunci
• API kunci tidak berfungsi dengan benar Base64 dikodekan dalam Authorization judul
• Hilang Otorisasi: Dasar judul

500 Internal Server Error

• Kesalahan pemrosesan sisi server
• Kegagalan pemrosesan dokumen Word
• Terjadi kesalahan saat menerapkan pengaturan keamanan.
• Terjadi kesalahan saat memuat dokumen dari byte.

Format Respons Kesalahan:

{
"error": "Error message describing what went wrong"
}

Response Format Details

Detail Format Respons

Penting: Yang API selalu kembali JSON, jangan pernah menggunakan data Word biner secara langsung.

Struktur Respons:

{
"document": "string", // Base64-encoded Word document with security applied
"fileName": "string", // Output Word filename
"success": true,
"errorMessage": "string or null"
}

Header Content-Type:

• Kesuksesan: application/json
• Dokumen Word disematkan sebagai Base64 tali di dalam JSON tanggapan

Mengapa Base64?

• JSON- Pengkodean aman untuk data biner
• Mudah ditransmisikan melalui HTTP
• Kompatibel dengan semua bahasa pemrograman
• Dapat langsung disematkan di JSON tanpa menghindari masalah

Mendekode Base64 ke Dokumen Word:

JavaScript/Node.js:

const base64 = response.document;
const binary = atob(base64); // Browser
// OR
const binary = Buffer.from(base64, 'base64'); // Node.js

Python:

import base64
word_bytes = base64.b64decode(response['document'])
with open('output.docx', 'wb') as f:
f.write(word_bytes)

C#:

byte[] wordBytes = Convert.FromBase64String(response.document);
File.WriteAllBytes("output.docx", wordBytes);

Contoh Permintaan

Judul

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

Catatan:

• Dapatkan milikmu API kunci dari PDF4me Dasbor
• Yang API kunci harus Base64 dikodekan dan diawali dengan "Basic" di dalam Authorization judul
• Contoh: Jika Anda API kuncinya adalah abc123, mengkodekannya menjadi Base64 dan menggunakan Authorization: Basic YWJjMTIz

Muatan

Contoh Sederhana (Hanya Perlindungan Kata Sandi):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "yes",
 "secureOnOpenPassword": "SecurePass123!"
}

Contoh Lanjutan (Kata Sandi + Perlindungan Hanya Baca):

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "yes",
 "secureOnOpenPassword": "SecurePass123!",
 "securityOptions": {
 "protectionType": "ReadOnly",
 "protectionPassword": "EditPass456!"
 }
}

Contoh Perlindungan Hanya untuk Komentar:

{
 "document": { "Name": "document.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "no",
 "securityOptions": {
 "protectionType": "AllowComments",
 "protectionPassword": "ReviewPass789!"
 }
}

Contoh Perlindungan Kolom Formulir:

{
 "document": { "Name": "form.docx" },
 "docContent": "base64EncodedDocumentContent",
 "secureOnOpen": "no",
 "securityOptions": {
 "protectionType": "AllowFormFields",
 "protectionPassword": "FormPass2024!"
 }
}

Contoh Kode

Yang PDF4me Dokumen Aman REST API Menyediakan contoh kode dalam berbagai bahasa pemrograman. Pilih bahasa yang paling sesuai dengan lingkungan pengembangan Anda:

C#

C# (CSharp) Contoh

Menyelesaikan C# Implementasi untuk mengamankan dokumen Word:

View C# Sample

Java

Java Contoh

Java Implementasi dengan penanganan kesalahan dan pemrosesan respons yang lengkap:

View Java Sample

JavaScript

JavaScript Contoh

Node.js dan kompatibel dengan browser JavaScript implementasi:

View JavaScript Sample

Python

Python Contoh

Python implementasi dengan pustaka permintaan dan JSON penanganan:

View Python Sample

Salesforce

Salesforce Contoh

Salesforce Apex implementasi untuk CRM integrasi:

View Salesforce Sample

n8n

n8n Contoh

n8n Implementasi alur kerja untuk otomatisasi:

View n8n Sample

Google Script

Google Script Contoh

Google Apps Script implementasi untuk Google Workspace integrasi:

View Google Script Sample

AWS Lambda

AWS Lambda Contoh

Tanpa server AWS Lambda implementasi fungsi:

View AWS Lambda Sample

Studi Kasus & Aplikasi Industri

Legal & Professional Services

Studi Kasus Layanan Hukum & Profesional

• Dokumen Klien RahasiaTerapkan perlindungan kata sandi pada dokumen hukum yang sensitif.
• Keamanan Kontrak: Mengamankan kontrak dengan perlindungan hanya baca untuk peninjauan klien
• Distribusi Formulir HukumTerapkan perlindungan kolom formulir pada formulir hukum.
• Tinjauan DokumenGunakan perlindungan hanya komentar untuk peninjauan dokumen hukum.

Business & Enterprise

Kasus Penggunaan Bisnis & Perusahaan

• Keamanan ProposalTerapkan perlindungan kata sandi pada proposal rahasia.
• Peninjauan Dokumen KlienGunakan perlindungan hanya komentar untuk peninjauan dokumen klien.
• Distribusi Formulir PemasaranTerapkan perlindungan kolom formulir pada formulir pemasaran.
• Kolaborasi Dokumen PenjualanGunakan perlindungan revisi untuk pengeditan dokumen penjualan.

Education & Research

Studi Kasus Pendidikan & Penelitian

• Keamanan Dokumen PasienTerapkan perlindungan kata sandi pada dokumen pasien yang bersifat rahasia.
• Perlindungan Laporan MedisLaporan medis yang aman dengan perlindungan hanya baca
• Kolaborasi Dokumen PenelitianGunakan perlindungan revisi untuk penyuntingan dokumen penelitian.
• Dokumen Akademik dan KelembagaanMengamankan silabus, hibah, dan dokumen internal.

Finance & Banking

Studi Kasus Keuangan & Perbankan

• Laporan Keuangan KeamananTerapkan perlindungan kata sandi pada laporan keuangan rahasia.
• Perlindungan Dokumen Audit: Amankan dokumen audit dengan perlindungan hanya baca
• Distribusi Formulir AnggaranTerapkan perlindungan kolom formulir pada formulir anggaran.
• Dokumentasi KepatuhanGunakan perlindungan revisi untuk pengeditan dokumen kepatuhan.

Dapatkan Bantuan

Get Your API KeyAPI SamplesGetting Started