Box
Konektor Box memungkinkan Anda terhubung ke backend Box dan menggunakan SQL untuk mengambil serta memperbarui data Box.
Versi yang didukung
Konektor ini mendukung Box Content API versi 2.0.
Sebelum memulai
Sebelum menggunakan konektor Box, lakukan tugas berikut:
- Di project Google Cloud Anda:
- Berikan peran IAM roles/connectors.admin kepada pengguna yang mengonfigurasi konektor.
- Berikan peran IAM berikut ke akun layanan yang ingin Anda gunakan untuk konektor:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
Akun layanan adalah jenis Akun Google khusus yang dimaksudkan untuk mewakili pengguna non-manusia yang perlu melakukan autentikasi dan diberi otorisasi untuk mengakses data di Google API. Jika tidak memiliki akun layanan, Anda harus membuat akun layanan. Untuk mengetahui informasi selengkapnya, lihat Membuat akun layanan.
- Aktifkan layanan berikut:
secretmanager.googleapis.com
(Secret Manager API)connectors.googleapis.com
(Connectors API)
Untuk memahami cara mengaktifkan layanan, lihat Mengaktifkan layanan.
Jika layanan atau izin ini belum diaktifkan untuk project Anda sebelumnya, Anda akan diminta untuk mengaktifkannya saat mengonfigurasi konektor.
Mengonfigurasi konektor
Mengonfigurasi konektor mengharuskan Anda membuat koneksi ke sumber data (sistem backend). Koneksi bersifat khusus untuk sumber data. Artinya, jika memiliki banyak sumber data, Anda harus membuat koneksi terpisah untuk setiap sumber data. Untuk membuat koneksi, lakukan langkah-langkah berikut:
- Di Konsol Cloud, buka halaman Integration Connectors > Connections, lalu pilih atau buat project Google Cloud.
- Klik + CREATE NEW untuk membuka halaman Create Connection.
- Di bagian Lokasi, pilih lokasi untuk koneksi.
- Region: Pilih lokasi dari menu drop-down.
Untuk mengetahui daftar semua wilayah yang didukung, lihat Lokasi.
- Klik BERIKUTNYA.
- Region: Pilih lokasi dari menu drop-down.
- Di bagian Connection Details, selesaikan tindakan berikut:
- Konektor: Pilih Box dari menu drop-down Konektor yang tersedia.
- Versi konektor: Pilih versi Konektor dari menu drop-down versi yang tersedia.
- Di kolom Connection Name, masukkan nama untuk instance Connection.
Nama koneksi harus memenuhi kriteria berikut:
- Nama koneksi dapat menggunakan huruf, angka, atau tanda hubung.
- Huruf harus kecil.
- Nama koneksi harus dimulai dengan huruf dan diakhiri dengan huruf atau angka.
- Nama koneksi tidak boleh lebih dari 63 karakter.
- Secara opsional, masukkan Deskripsi untuk instance koneksi.
- Akun Layanan: Pilih akun layanan yang memiliki peran yang diperlukan.
- Secara opsional, konfigurasikan Setelan node koneksi:
- Jumlah minimum node: Masukkan jumlah minimum node koneksi.
- Jumlah maksimum node: Masukkan jumlah maksimum node koneksi.
{i>Node<i} adalah unit (atau replika) koneksi yang memproses transaksi. Lebih banyak node diperlukan untuk memproses lebih banyak transaksi untuk sebuah koneksi dan sebaliknya, lebih sedikit node diperlukan untuk memproses transaksi yang lebih sedikit. Untuk memahami pengaruh node terhadap harga konektor Anda, lihat Harga untuk node koneksi. Jika Anda tidak memasukkan nilai apa pun, secara default node minimum akan ditetapkan ke 2 (untuk ketersediaan yang lebih baik) dan node maksimum ditetapkan ke 50.
- Meniru Peniruan Mode Pengguna: Tentukan jenis peniruan identitas pengguna. Pilihannya harus berupa mode Pengguna atau mode Admin.
- Use proxy: Centang kotak ini guna mengonfigurasi server proxy untuk koneksi dan mengonfigurasi nilai berikut:
-
Proxy Auth Scheme: Pilih jenis autentikasi untuk mengautentikasi dengan server proxy. Jenis autentikasi berikut didukung:
- Dasar: Autentikasi HTTP dasar.
- Ringkasan: Autentikasi HTTP ringkasan.
- Pengguna Proxy: Nama pengguna yang akan digunakan untuk melakukan autentikasi dengan server proxy.
- Sandi Proxy: Rahasia Secret manager sandi pengguna.
-
Jenis SSL Proxy: Jenis SSL yang akan digunakan saat terhubung ke server proxy. Jenis autentikasi berikut didukung:
- Otomatis: Setelan default. Jika URL adalah URL HTTPS, opsi Tunnel akan digunakan. Jika URL adalah URL HTTP, opsi JANGAN digunakan.
- Selalu: Koneksi selalu mengaktifkan SSL.
- Tidak pernah: Koneksi tidak mengaktifkan SSL.
- Tunnel: Koneksi melalui proxy tunneling. Server proxy membuka koneksi ke host jarak jauh dan traffic mengalir bolak-balik melalui proxy.
- Di bagian Server Proxy, masukkan detail server proxy.
- Klik + Tambahkan tujuan.
- Pilih Jenis Tujuan.
- Alamat host: Tentukan nama host atau alamat IP tujuan.
Jika ingin membuat koneksi pribadi ke sistem backend Anda, lakukan hal berikut:
- Buat lampiran layanan PSC.
- Buat lampiran endpoint, lalu masukkan detail lampiran endpoint di kolom Alamat host.
- Alamat host: Tentukan nama host atau alamat IP tujuan.
- Secara opsional, klik + TAMBAHKAN LABEL untuk menambahkan label ke Koneksi dalam bentuk pasangan kunci/nilai.
- Klik BERIKUTNYA.
-
Di bagian Authentication, masukkan detail autentikasi.
- Pilih Jenis autentikasi, lalu masukkan detail yang relevan.
Jenis autentikasi berikut didukung oleh koneksi Box:
- OAuth 2.0 - Kredensial klien
- OAuth 2.0 - Kode otorisasi
- Klik BERIKUTNYA.
Untuk memahami cara mengonfigurasi jenis autentikasi ini, lihat Mengonfigurasi autentikasi.
- Pilih Jenis autentikasi, lalu masukkan detail yang relevan.
- Tinjau: Tinjau detail koneksi dan autentikasi Anda.
- Klik Create.
Mengonfigurasi autentikasi
Masukkan detail berdasarkan autentikasi yang ingin Anda gunakan.
-
OAuth 2.0 - Kredensial klien
- Client-ID: Client ID yang diberikan oleh konektor untuk aplikasi yang Anda buat.
- Rahasia Klien: Secret Manager yang berisi rahasia klien untuk aplikasi terhubung yang Anda buat.
- Kunci Pribadi: Secret Manager Secret yang berisi isi file kunci pribadi. Kunci pribadi harus cocok dengan kunci/sertifikat publik yang diberikan pada Connector.
- Sandi Kunci Pribadi: Rahasia Secret Manager yang berisi sandi (parafrasa) file kunci pribadi.
- Box Application Access Level: Tingkat Akses Aplikasi untuk Aplikasi Box
- ID Pengguna/ID Perusahaan: ID Perusahaan jika Tingkat aplikasi adalah perusahaan dan ID Pengguna jika Tingkat Aplikasi adalah pengguna
- OAuth JWT Public Key Id: ID kunci publik untuk JWT.
- Skema Auth: Skema Auth untuk Konektor Box
- Memulai OAuth: Memulai parameter OAuth untuk Box Connector
- Jenis Sertifikat JWT OAuth: Jenis Sertifikat JWT OAuth untuk Konektor Box
- OAuth 2.0 - Kode otorisasi
- Client-ID: Client ID yang diberikan oleh aplikasi eksternal Anda.
- Cakupan: Cakupan izin. Contoh,
root_readonly
. Untuk memahami cara kerja cakupan dan melihat semua cakupan yang tersedia untuk Box, lihat Cakupan. - Rahasia klien: Pilih Secret Manager. Anda seharusnya sudah membuat rahasia Secret Manager sebelum mengonfigurasi otorisasi ini.
- Versi secret: Versi rahasia Secret Manager untuk rahasia klien.
Untuk jenis autentikasi Authorization code
, setelah membuat koneksi, Anda harus melakukan beberapa langkah tambahan untuk mengonfigurasi autentikasi. Untuk mengetahui informasi selengkapnya,
lihat Langkah tambahan setelah pembuatan koneksi.
Langkah-langkah tambahan setelah pembuatan koneksi
Jika memilih OAuth 2.0 - Authorization code
untuk autentikasi, Anda harus melakukan langkah-langkah tambahan berikut setelah membuat koneksi:
- Di halaman Koneksi, temukan koneksi yang baru dibuat.
Perhatikan bahwa Status untuk konektor baru adalah Diperlukan otorisasi.
- Klik Diperlukan otorisasi.
Ini akan menampilkan panel Edit authorization.
- Salin nilai Redirect URI ke aplikasi eksternal Anda.
- Verifikasi detail otorisasi.
- Klik Authorize.
Jika otorisasi berhasil, status koneksi akan disetel ke Active di halaman Koneksi.
Otorisasi ulang untuk kode otorisasi
Jika Anda menggunakan jenis autentikasi Authorization code
dan telah membuat perubahan konfigurasi dalam aplikasi Box,
Anda harus mengizinkan ulang koneksi Box. Untuk mengizinkan ulang koneksi, lakukan langkah-langkah berikut:
- Klik koneksi yang diperlukan di halaman Koneksi.
Tindakan ini akan membuka halaman detail koneksi.
- Klik Edit untuk mengedit detail koneksi.
- Verifikasi detail OAuth 2.0 - Authorization code di bagian Authentication.
Jika diperlukan, buat perubahan yang diperlukan.
- Klik Save. Tindakan ini akan mengarahkan Anda ke halaman detail koneksi.
- Klik Edit authorization di bagian Authentication. Tindakan ini akan menampilkan panel Authorize.
- Klik Authorize.
Jika otorisasi berhasil, status koneksi akan disetel ke Aktif di halaman Koneksi.
Entitas, operasi, dan tindakan
Semua Integration Connectors menyediakan lapisan abstraksi untuk objek aplikasi yang terhubung. Anda hanya dapat mengakses objek aplikasi melalui abstraksi ini. Abstraksi ditampilkan kepada Anda sebagai entity, operasi, dan tindakan.
- Entity: Entity dapat dianggap sebagai objek, atau kumpulan properti, dalam
aplikasi atau layanan yang terhubung. Definisi entity berbeda dari konektor ke konektor. Misalnya, pada konektor database, tabel adalah entity, pada konektor server file, folder adalah entity, dan di konektor sistem pesan, antrean adalah entity.
Namun, mungkin saja konektor tidak mendukung atau memiliki entitas, dalam hal ini daftar
Entities
akan kosong. - Operasi: Operasi adalah aktivitas yang dapat Anda lakukan pada entity. Anda dapat melakukan
salah satu operasi berikut pada entitas:
Memilih entity dari daftar yang tersedia akan menghasilkan daftar operasi yang tersedia untuk entity tersebut. Untuk deskripsi operasi secara mendetail, lihat operasi entity tugas Konektor. Namun, jika konektor tidak mendukung salah satu operasi entity, operasi yang tidak didukung tersebut tidak akan dicantumkan dalam daftar
Operations
. - Tindakan: Tindakan adalah fungsi kelas pertama yang tersedia untuk integrasi melalui antarmuka konektor. Tindakan memungkinkan Anda membuat perubahan pada satu atau beberapa entitas, dan bervariasi dari satu konektor ke konektor lainnya. Namun, mungkin saja konektor tidak mendukung tindakan apa pun, dalam hal ini daftar
Actions
akan kosong.
Tindakan
Bagian ini mencantumkan semua tindakan yang didukung oleh koneksi Box.
Tindakan DownloadFile
Tindakan ini memungkinkan Anda mendownload file dari instance Box.
Parameter input tindakan DownloadFile
Nama Parameter | Jenis Data | Diperlukan | Deskripsi |
---|---|---|---|
FileID | String | Ya | ID file yang akan didownload. |
HasBytes | Boolean | Ya | Menentukan apakah file akan didownload sebagai string atau sebagai string berenkode Base64. |
Parameter output tindakan DownloadFile
Tindakan ini akan menampilkan status 200 (OK) dengan isi respons yang menunjukkan hasilnya.
Nama Parameter | Jenis Data | Deskripsi |
---|---|---|
Berhasil | String | Menentukan apakah download file berhasil. |
ContentBytes | String | Konten file sebagai string berenkode Base64. |
Untuk mengetahui contoh cara mengonfigurasi tindakan DownloadFile
, lihat Contoh tindakan.
Tindakan UploadFile
Tindakan ini memungkinkan Anda mengupload file ke instance Box.
Parameter input tindakan UploadFile
Nama Parameter | Jenis Data | Diperlukan | Deskripsi |
---|---|---|---|
ParentID | String | Ya | ID folder tempat Anda ingin mengupload file. Jika parameter ini tidak ditentukan, file akan diupload ke root akun Box. Nilai defaultnya adalah 0. |
Konten | String | Ya | Konten file yang akan diupload. |
Parameter output tindakan UploadFile
Tindakan ini akan menampilkan status 200 (OK) dengan isi respons yang menunjukkan hasilnya.
Nama Parameter | Jenis Data | Deskripsi |
---|---|---|
Berhasil | String | Menentukan apakah upload file berhasil. |
ID | String | ID file yang baru dibuat. |
VersionID | String | ID versi file tertentu. |
Hash | String | Hash SHA1 file. |
Etag | String | Nilai Etag file atau folder. Nilai defaultnya adalah 0. |
Untuk mengetahui contoh cara mengonfigurasi tindakan UploadFile
, lihat Contoh tindakan.
Tindakan CopyFile
Tindakan ini memungkinkan Anda menyalin file dari instance Box.
Parameter input tindakan CopyFile
Nama Parameter | Jenis Data | Diperlukan | Deskripsi |
---|---|---|---|
FileID | String | Ya | ID file yang ingin disalin. |
DestinationFolderId | String | Tidak | ID folder tujuan tempat Anda ingin menyalin file. Jika Anda tidak menentukan nilai apa pun, versi terbaru file akan disalin. |
NewName | String | Ya | Nama file baru untuk file yang disalin. |
Parameter output tindakan CopyFile
Tindakan ini akan menampilkan status 200 (OK) dengan isi respons yang menunjukkan hasilnya.
Nama Parameter | Jenis Data | Deskripsi |
---|---|---|
Berhasil | String | Menentukan apakah penyalinan file berhasil. |
ID | String | ID file yang disalin. |
Untuk mengetahui contoh cara mengonfigurasi tindakan CopyFile
, lihat Contoh tindakan.
Tindakan SalinFolder
Tindakan ini memungkinkan Anda menyalin seluruh folder dari instance Box.
Parameter input tindakan CopyFolder
Nama Parameter | Jenis Data | Diperlukan | Deskripsi |
---|---|---|---|
FolderID | String | Ya | ID folder yang ingin Anda salin. |
DestinationFolderId | String | Ya | ID folder tujuan tempat Anda ingin menyalin folder. |
NewName | String | Tidak | Nama file baru untuk folder yang disalin. |
Parameter output tindakan CopyFolder
Tindakan ini akan menampilkan status 200 (OK) dengan isi respons yang menunjukkan hasilnya.
Nama Parameter | Jenis Data | Deskripsi |
---|---|---|
Berhasil | String | Menentukan apakah folder berhasil disalin. |
ID | String | ID folder yang disalin. |
Untuk mengetahui contoh cara mengonfigurasi tindakan CopyFolder
, lihat Contoh tindakan.
Contoh tindakan
Bagian ini menjelaskan cara melakukan beberapa tindakan dalam konektor ini.
Contoh - Mengunduh file
- Dalam dialog
Configure connector task
, klikActions
. - Pilih tindakan
DownloadFile
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "FileID": "1283194869422", "HasBytes": true }
Contoh ini mendownload file sebagai string berenkode Base64. Jika tindakan tersebut berhasil, parameter respons connectorOutputPayload
tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:
[ { "Success": "True"}, {"ContentBytes": "JVBERi0xLjQKJcfl9OXwCjIgMCBvYmoKJSBbMjRdIAo8PAovRmlsdGVy"} ]
Contoh - Upload file
- Dalam dialog
Configure connector task
, klikActions
. - Pilih tindakan
UploadFile
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "ParentId": "0", "Content": "12345" }
Contoh ini mengupload konten string sebagai file. Jika tindakan tersebut berhasil, parameter respons connectorOutputPayload
tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:
[{ "Success": "true", "ID": "1283902965389", "VersionID": "1403546001389", "Hash": "8cb2237d0679ca88db6464eac60da96345513964", "Etag": "0" }]
Contoh - Menyalin file
- Dalam dialog
Configure connector task
, klikActions
. - Pilih tindakan
CopyFile
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "FileID": "1288751886061", "DestinationFolderId": "219105724517", "NewName": "NewCopiedFile" }
Contoh ini menyalin file dengan ID 1288751886061
ke folder dengan ID 219105724517
. Jika tindakan tersebut berhasil, parameter respons connectorOutputPayload
tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:
[{ "Success": "true", "ID": "1308006018536" }]
Contoh - Menyalin folder
- Dalam dialog
Configure connector task
, klikActions
. - Pilih tindakan
CopyFolder
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "FolderID": "218475301279", "DestinationFolderId": "0", "NewName": "NewCopiedFolder" }
Contoh ini menyalin folder dengan ID 218475301279
ke folder dengan ID 219105724517
. Jika tindakan tersebut berhasil, parameter respons connectorOutputPayload
tugas konektor Anda akan memiliki nilai yang mirip dengan berikut ini:
[{ "Success": "true", "ID": "226312444517" }]
Contoh operasi entitas
Contoh - Buat daftar semua file
Contoh ini mencantumkan file dalam entity Files
.
- Dalam dialog
Configure connector task
, klikEntities
. - Pilih
Files
dari daftarEntity
. - Pilih operasi
LIST
, lalu klik Done. - Secara opsional, Anda dapat memasukkan nilai dalam filterClause untuk memfilter kumpulan hasil.
Contoh - Dapatkan tiket
Contoh ini mendapatkan file tertentu dari entity Files
.
- Dalam dialog
Configure connector task
, klikEntities
. - Pilih
Tickets
dari daftarEntity
. - Pilih operasi
GET
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik EntityId lalu masukkan
35
di kolom Default Value.Di sini,
35
adalah nilai kunci utama entityTickets
.
Contoh - Membuat tiket
Contoh ini membuat tiket dalam entity Tickets
.
- Dalam dialog
Configure connector task
, klikEntities
. - Pilih
Tickets
dari daftarEntity
. - Pilih operasi
Create
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "Subject": "Create_Ticket_01", "Description": "Test", "Type": "incident", "Priority": "urgent", "Status": "open", "Recipient": null, "HasIncidents": false, "DueAt": null, "RequesterId": 3.84625885158E11, "SubmitterId": 3.84625883418E11, "AssigneeId": 3.84625883418E11, "OrganizationId": "16665992392721", "GroupId": 3.60008282358E11, "TicketFormId": 3.60001719218E11, "BrandId": 3.60003285058E11 }
Jika integrasi berhasil, kolom
connectorOutputPayload
tugas konektor akan memiliki nilai yang mirip dengan berikut ini:{ "Id": 38.0 }
Contoh - Memperbarui tiket
Contoh ini memperbarui tiket yang ID-nya adalah 35 di entity Tickets
.
- Dalam dialog
Configure connector task
, klikEntities
. - Pilih Tiket dari daftar
Entity
. - Pilih operasi
Update
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik
connectorInputPayload
, lalu masukkan nilai yang mirip dengan berikut di kolomDefault Value
:{ "Subject": "Update_Ticket_02", "Description": "Updating the ticket", "RequesterId": 1.6854335860497E13 }
- Klik entityId, lalu masukkan
35
di kolom Nilai Default.Atau, daripada menentukan entityId, Anda juga dapat menetapkan filterClause ke
35
.Jika integrasi berhasil, kolom
connectorOutputPayload
tugas konektor akan memiliki nilai yang mirip dengan berikut ini:{ Id": 35.0 }
Contoh - Menghapus tiket
Contoh ini memperbarui tiket yang ID-nya adalah 35 di entity Tickets
.
- Dalam dialog
Configure connector task
, klikEntities
. - Pilih Tiket dari daftar
Entity
. - Pilih operasi
Delete
, lalu klik Done. - Di bagian Task Input pada tugas Connectors, klik entityId, lalu masukkan
35
di kolom Default Value.
Gunakan terraform untuk membuat koneksi
Anda dapat menggunakan resource Terraform untuk membuat koneksi baru.Untuk mempelajari cara menerapkan atau menghapus konfigurasi Terraform, lihat Perintah dasar Terraform.
Untuk melihat contoh template terraform untuk pembuatan koneksi, lihat contoh template.
Saat membuat koneksi ini menggunakan Terraform, Anda harus menetapkan variabel berikut dalam file konfigurasi Terraform:
Nama parameter | Jenis data | Diperlukan | Deskripsi |
---|---|---|---|
impersonate_user_mode | ENUM | Benar | Tentukan jenis peniruan identitas pengguna. Pilihannya harus berupa mode Pengguna atau mode Admin. Nilai yang didukung adalah: User, Admin |
proxy_enabled | BOOLEAN | Salah | Pilih kotak centang ini untuk mengonfigurasi server proxy untuk koneksi. |
proxy_auth_scheme | ENUM | Salah | Jenis autentikasi yang akan digunakan untuk mengautentikasi ke proxy ProxyServer. Nilai yang didukung adalah: BASIC, DIGEST, NONE |
proxy_user | STRING | Salah | Nama pengguna yang akan digunakan untuk mengautentikasi ke proxy ProxyServer. |
proxy_password | SECRET | Salah | Sandi yang akan digunakan untuk mengautentikasi ke proxy ProxyServer. |
proxy_ssltype | ENUM | Salah | Jenis SSL yang akan digunakan saat menghubungkan ke proxy ProxyServer. Nilai yang didukung adalah: AUTO, ALWAYS, NEVER, WorkManager |
Menggunakan koneksi Box dalam integrasi
Setelah Anda membuat koneksi, koneksi tersebut akan tersedia di Apigee Integration dan Application Integration. Anda dapat menggunakan koneksi dalam integrasi melalui tugas Konektor.
- Untuk memahami cara membuat dan menggunakan tugas Konektor di Integrasi Apigee, lihat Tugas konektor.
- Untuk memahami cara membuat dan menggunakan tugas Konektor dalam Application Integration, lihat tugas konektor.
Dapatkan bantuan dari komunitas Google Cloud
Anda dapat memposting pertanyaan dan mendiskusikan konektor ini di komunitas Google Cloud di Cloud Forums.Langkah selanjutnya
- Memahami cara menangguhkan dan melanjutkan koneksi.
- Pahami cara memantau penggunaan konektor.
- Pahami cara melihat log konektor.