Mengambil kredensial Tampilan dan pengeditan untuk dokumen.
Deskripsi operasi
-
Sebelum menggunakan operasi ini, pastikan Anda telah memahami penagihan Intelligent Media Management. Untuk informasi selengkapnya, lihat Harga.
-
Jangan melakukan akses lintas batas pada file OSS. Misalnya, jika file disimpan di bucket di Wilayah Singapura, jangan memulai permintaan Tampilan, baca, atau unduh dari daratan Tiongkok. Dalam skenario tersebut, kualitas tautan jaringan sangat terpengaruh oleh lingkungan jaringan lintas batas, yang dapat menyebabkan peningkatan latensi akses, kegagalan Tampilan, gangguan unduhan, atau koneksi yang tidak stabil. Stabilitas jaringan dan pengalaman akses tidak dapat dijamin. Pastikan titik akses dan bucket berada di Wilayah yang sama untuk menghindari ketidakpastian yang disebabkan oleh akses lintas batas.
-
Kredensial akses kedaluwarsa dalam 30 menit, dan Token penyegaran kedaluwarsa dalam 1 hari.
-
Pengatur waktu kedaluwarsa yang dikembalikan dalam UTC, yang tertinggal 8 jam dari UTC+8.
-
format file input yang didukung:
Dokumen Word: doc, docx, txt, dot, wps, wpt, dotx, docm, dotm, dan rtf.
Dokumen presentasi (PPT): ppt, pptx, pptm, ppsx, ppsm, pps, potx, potm, dpt, dan dps.
Dokumen Excel: et, xls, xlt, xlsx, xlsm, xltx, xltm, dan csv.
Dokumen PDF: pdf.
-
Ukuran file maksimum yang didukung adalah 200 MB.
-
Jumlah halaman dokumen maksimum yang didukung adalah 5.000.
-
Untuk Proyek yang dibuat sebelum 1 Desember 2023, penagihan didasarkan pada jumlah pembukaan dokumen. Saat ini, penagihan didasarkan pada jumlah panggilan API. Untuk beralih ke mode penagihan baru, buat Proyek baru. Perhatikan bahwa setiap panggilan API hanya dapat digunakan oleh satu pengguna. Jika panggilan digunakan kembali, hanya pengguna terakhir yang dapat mengakses dokumen secara normal, dan izin akses pengguna lain akan dicabut.
-
Aktifkan Message Service (MNS) di Wilayah yang sama dengan Intelligent Media Management, buat Topik dan Antrian, lalu konfigurasikan langganan. Anda dapat meneruskan nama Topik MNS menggunakan parameter NotifyTopicName untuk menerima Notifikasi Paket tentang penyimpanan file. Untuk informasi selengkapnya tentang MNS SDK, lihat Menerima dan menghapus Paket. Untuk contoh format JSON bidang Message dalam Notifikasi Paket penyimpanan file, lihat format notifikasi pesan WebOffice.
Untuk menggunakan fitur pengendalian versi, Anda harus terlebih dahulu mengaktifkan pengendalian versi di OSS lalu mengatur parameter History menjadi true. .
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
imm:GenerateWebofficeToken |
none |
*Project
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| ProjectName |
string |
Yes |
Nama Proyek. Untuk informasi tentang cara mendapatkan nama Proyek, lihat Membuat Proyek. |
test-project |
| SourceURI |
string |
Yes |
URI OSS dokumen yang akan Tampilan atau diedit. URI OSS mengikuti format |
oss://test-bucket/test-object.docx |
| Filename |
string |
No |
Nama file, yang harus menyertakan ekstensi nama file. Nilai default adalah segmen terakhir dari parameter SourceURI. Ekstensi nama file yang didukung (PDF hanya mendukung Tampilan):
|
test-Object.pptx |
| CachePreview |
boolean |
No |
Apakah akan mengaktifkan Tampilan cache.
Penting Tampilan cache dan Tampilan non-cache memiliki harga satuan yang berbeda. Untuk informasi selengkapnya, lihat deskripsi item penagihan.
Penting Tampilan cache tidak mendukung pencarian konten dokumen atau pencetakan. Penting Tampilan cache tidak mendukung pembaruan konten cache. |
true、false |
| Referer |
string |
No |
Referer perlindungan hotlink OSS. Intelligent Media Management (IMM) perlu mengambil file sumber dari OSS. Jika perlindungan hotlink dikonfigurasi untuk OSS, IMM harus meneruskan header yang sesuai ke OSS untuk mengambil file sumber. Catatan
Atur parameter ini jika bucket yang menyimpan dokumen memiliki referer yang dikonfigurasi. |
* |
| UserData |
string |
No |
Data pengguna kustom. Parameter ini hanya berlaku ketika parameter Notification ditentukan dengan konfigurasi MNS. Data dikembalikan dalam Notifikasi Paket asinkron agar Anda dapat mengaitkan dan memproses Notifikasi Paket dalam sistem Anda. Panjang maksimum: 2.048 byte. |
{ "id": "test-id", "name": "test-name" } |
| PreviewPages |
integer |
No |
Jumlah halaman maksimum yang dapat Tampilan. Secara default, tidak ada batas yang diterapkan. Nilai maksimum adalah 5.000. |
5 |
| Password |
string |
No |
Kata sandi untuk membuka dokumen. Catatan
Atur parameter ini jika Anda ingin Tampilan atau mengedit dokumen yang dilindungi kata sandi. |
123456 |
| ExternalUploaded |
boolean |
No |
Apakah mengunggah file dengan nama yang sama ke OSS merupakan perilaku yang diharapkan. Nilai valid:
|
false |
| NotifyTopicName |
string |
No |
Mengirim Notifikasi event kepada Anda sebagai Paket MNS. Parameter ini menentukan Topik MNS untuk Notifikasi Paket asinkron. |
test-topic |
| Hidecmb |
boolean |
No |
Apakah akan menyembunyikan Bilah alat. Parameter ini didukung dalam mode Tampilan dokumen. Nilai valid:
|
false |
| Permission | WebofficePermission |
No |
Informasi izin pengguna dalam format JSON. Izin pengguna mencakup opsi berikut: Setiap opsi bertipe Boolean. Nilai default adalah false. Nilai valid: true dan false.
Catatan
PDF hanya mendukung fitur Tampilan. Anda harus mengatur parameter Readonly menjadi true. Catatan
File PDF tidak mendukung ekspor. Catatan
Untuk menggunakan fitur Pengendalian versi, Anda harus terlebih dahulu mengaktifkan Pengendalian versi di OSS lalu mengatur parameter History menjadi true. Penting Pencetakan tidak didukung dalam Tampilan cache. Penting Versi historis dapat dilihat dalam mode pengeditan tetapi tidak dalam mode Tampilan. |
|
| User | WebofficeUser |
No |
Informasi pengguna. Anda dapat meneruskan informasi pengguna dari sisi bisnis, dan halaman WebOffice menampilkan informasi ini. Sistem membedakan pengguna yang berbeda berdasarkan User.Id. User.Name hanya digunakan untuk tampilan antarmuka depan. Jika User.Id tidak ditentukan, backend secara otomatis menghasilkan ID acak. Pengguna dengan ID yang berbeda diperlakukan sebagai prinsipal yang berbeda dan tidak dapat memodifikasi atau menghapus komentar satu sama lain. Format default adalah: Unknown_RandomString. Jika User.Id tidak ditentukan, informasi pengguna ditampilkan sebagai "Unknown" secara default. |
|
| Watermark | WebofficeWatermark |
No |
Informasi Watermark. Watermark dihasilkan di antarmuka depan dan tidak ditulis ke dokumen sumber. Parameter berbeda yang diteruskan untuk dokumen yang sama menghasilkan Watermark yang berbeda. |
|
| CredentialConfig | CredentialConfig |
No |
Biarkan parameter ini kosong kecuali Anda memiliki persyaratan khusus. Konfigurasi otorisasi Tiongkok. Parameter ini bersifat opsional. Untuk informasi selengkapnya, lihat Menggunakan otorisasi berantai untuk mengakses resource entitas lain. |
|
| Notification | Notification |
No |
Konfigurasi Notifikasi. Saat ini, hanya MNS yang didukung. Untuk format pesan Notifikasi asinkron, lihat format notifikasi pesan WebOffice. Catatan
Notifikasi Paket dikirim saat file disimpan atau diganti namanya. |
Contoh skenario tipikal
Contoh berikut menjelaskan beberapa skenario tipikal berdasarkan struktur parameter:
Tampilan file hanya-baca (diperlukan untuk Tampilan file PDF)
Mode Tampilan dokumen. Dokumen hanya dapat Tampilan dan tidak dapat diedit:
{
"ProjectName" : "test-project",
"SourceURI" : "oss://test-bucket/test-object.pdf",
"Filename" : "test-object.docx",
"PreviewPages" : "5",
"Permission" : "{'Readonly':'true'}"
}
Tampilan file dengan ekstensi nama file huruf besar
Untuk Tampilan file dengan ekstensi nama file huruf besar, atur parameter Filename dengan ekstensi huruf kecil:
{
"ProjectName" : "test-project",
"SourceURI" : "oss://test-bucket/test-object.DOCX",
"Filename" : "test-object.docx",
"PreviewPages" : "5",
"Permission" : "{'Readonly':'true'}"
}
Tampilan hanya 5 halaman pertama dokumen
Dokumen memiliki total 10 halaman. Hanya 5 halaman pertama yang ditampilkan:
{
"ProjectName" : "test-project",
"SourceURI" : "oss://test-bucket/test-object.docx",
"Filename" : "test-object.docx",
"PreviewPages" : "5",
"Permission" : "{'Readonly':'true'}"
}
Mengatur kata sandi untuk Tampilan dokumen
Atur kata sandi untuk Tampilan dokumen, atau langsung buka file sumber yang dilindungi kata sandi tanpa memerlukan kata sandi:
{
"ProjectName" : "test-project",
"SourceURI" : "oss://test-bucket/test-object.docx",
"Filename" : "test-object.docx",
"Password" : "123456",
"Permission" : "{'Readonly':'true'}"
}
Menambahkan Watermark ke Tampilan dokumen
Tambahkan Watermark saat Tampilan dokumen:
{
"ProjectName" : "test-project",
"SourceURI" : "oss://test-bucket/test-object.docx",
"Filename" : "test-object.docx",
"Watermark" : "{'Type':'1','Value':'nilai Watermark','Font':'bold 20px Serif'}",
"Permission" : "{'Readonly':'true'}"
}
Menyembunyikan Bilah alat selama Tampilan dokumen
Sembunyikan Bilah alat saat Tampilan dokumen:
{
"ProjectName" : "test-project",
"SourceURI" : "oss://test-bucket/test-object.docx",
"Filename" : "test-object.docx",
"Hidecmb" : "true",
"Permission" : "{'Readonly':'true'}"
}
Mengedit dokumen online dengan izin untuk melihat versi historis, menyalin, mencetak, dan mengekspor ke PDF
Edit dokumen online dengan izin untuk melihat versi historis, menyalin, mencetak, dan mengekspor ke PDF:
{
"ProjectName" : "test-project",
"SourceURI" : "oss://test-bucket/test-object.docx",
"Filename" : "test-object.docx",
"Permission" : "{'Readonly':'false','History':'true','Copy':'true','Print':'true','Export':'true'}"
}
```.
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Kredensial akses Weboffice. |
||
| RequestId |
string |
ID permintaan. |
1759315A-CB33-0A75-A72B-62D7******** |
| WebofficeURL |
string |
URL entri Weboffice untuk Tampilan atau mengedit dokumen secara online. Catatan
URL ini tidak dapat dibuka langsung di browser. Anda harus menggunakannya bersama dengan Weboffice JS-SDK dan Kredensial akses (AccessToken) untuk Tampilan atau mengedit dokumen. Untuk informasi selengkapnya, lihat Memulai. |
https://office-cn-shanghai.imm.aliyuncs.com/office/s/dd221b2cdb44fb66e9070d1d70a8b9bbb6d6fff7?_w_tokentype=1 |
| AccessToken |
string |
Kredensial akses Weboffice. |
2d73dd5d87524c5e8a194c3eb5******** |
| RefreshToken |
string |
Kredensial penyegaran Weboffice. |
e374995ec532432bb678074d36******** |
| AccessTokenExpiredTime |
string |
Pengatur waktu kedaluwarsa kredensial akses. Kredensial kedaluwarsa dalam 30 menit. format: YYYY-MM-DDTHH:mm:ss. |
2021-08-30T13:13:11.347146982Z |
| RefreshTokenExpiredTime |
string |
Pengatur waktu kedaluwarsa Token penyegaran. Kredensial kedaluwarsa dalam 1 hari. format: YYYY-MM-DDTHH:mm:ss. |
2021-08-31T12:43:11.347146982Z |
Error umum.
Proyek yang ditentukan oleh ProjectName tidak ditemukan. Buka konsol IMM dan periksa apakah proyek ada di wilayah tersebut.
{
"Code": "ResourceNotFound",
"Message": "The specified resource acs:imm::xxx:project/xxx is not found"
}
```.
Parameter User wajib diisi. Periksa apakah parameter ini ditentukan.
{ "Code": "InvalidArgument.User", "Message": "The parameter User is required but not provided" }
Parameter User tidak valid. Periksa apakah nilai parameter dalam format JSON yang valid.
{ "Code": "InvalidJSON parsing error, User", "Message": "Specified parameter JSON parsing error, User is not valid." }
Parameter Permission tidak valid. Periksa apakah nilai parameter dalam format JSON yang valid.
{ "Code": "InvalidJSON parsing error, Permission", "Message": "Specified parameter JSON parsing error, Permission is not valid." }
Parameter Watermark tidak valid. Periksa apakah nilai parameter dalam format JSON yang valid.
{ "Code": "InvalidJSON parsing error, Watermark", "Message": "Specified parameter JSON parsing error, Watermark is not valid." }
format parameter PreviewPages tidak valid. Periksa nilai parameter PreviewPages.
{ "Code": "InvalidPreviewPages", "Message": "Specified parameter PreviewPages is not valid." }
File OSS yang ditentukan oleh SourceURI tidak ada. Periksa apakah file ada di bucket.
{ "Code": "ResourceNotFound", "Message": "The specified resource oss://xx is not found" }
Contoh
Respons sukses
JSONformat
{
"RequestId": "1759315A-CB33-0A75-A72B-62D7********",
"WebofficeURL": "https://office-cn-shanghai.imm.aliyuncs.com/office/s/dd221b2cdb44fb66e9070d1d70a8b9bbb6d6fff7?_w_tokentype=1",
"AccessToken": "2d73dd5d87524c5e8a194c3eb5********",
"RefreshToken": "e374995ec532432bb678074d36********",
"AccessTokenExpiredTime": "2021-08-30T13:13:11.347146982Z",
"RefreshTokenExpiredTime": "2021-08-31T12:43:11.347146982Z"
}
Kode kesalahan
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.