View a markdown version of this page

Integrasi Smartsheet - Amazon Quick
PrasyaratKonfigurasikan Alat Pengembang SmartsheetCakupan akses OAuthSiapkan integrasi di Amazon QuickTindakan yang tersediaKelola dan pecahkan masalah

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Integrasi Smartsheet

Gunakan konektor tindakan Smartsheet untuk mengelola lembar, baris, laporan, dan pencarian di seluruh ruang kerja Smartsheet Anda secara langsung di Amazon Quick melalui bahasa alami. Integrasi ini menggunakan Smartsheet API. Untuk informasi selengkapnya, lihat pengenalan Smartsheet API di dokumentasi Smartsheet.

Menyiapkan integrasi ini melibatkan dua langkah. Pertama, Anda mengonfigurasi kredensional di Smartsheet untuk metode otentikasi yang Anda pilih. Kemudian, Anda membuat integrasi di Amazon Quick dan menghubungkannya ke akun Smartsheet Anda. Untuk informasi tentang metode otentikasi yang didukung Amazon Quick, lihatMetode autentikasi.

Prasyarat

Sebelum Anda mengatur integrasi, pastikan Anda memenuhi persyaratan berikut:

Konfigurasikan Alat Pengembang Smartsheet

Sebelum Anda mengonfigurasi Amazon Quick, atur kredensional di Smartsheet. Langkah-langkah yang Anda selesaikan bergantung pada metode otentikasi yang Anda rencanakan untuk digunakan. Amazon Quick mendukung dua metode otentikasi untuk Smartsheet. Untuk informasi lebih lanjut tentang metode ini, lihatMetode autentikasi.

Untuk informasi selengkapnya tentang Smartsheet OAuth, lihat OAuth di dokumentasi Smartsheet API.

Daftar Alat Pengembang dan buat profil pengembang

  1. Buka halaman Pendaftaran Alat Pengembang dan daftarkan akun Smartsheet yang ingin Anda gunakan dengan aplikasi Anda. Untuk informasi selengkapnya, lihat Mendaftar Alat Pengembang di dokumentasi API Smartsheet.

  2. Setelah Smartsheet mengaktifkan Alat Pengembang, masuk ke aplikasi Smartsheet dan pilih ikon Akun Anda di sudut kiri bawah, lalu pilih Alat Pengembang.

  3. Pilih Buat Profil Pengembang dan masukkan nama profil. Untuk informasi selengkapnya, lihat Membuat profil pengembang Anda di dokumentasi Smartsheet API.

Tip

Smartsheet merekomendasikan penggunaan akun layanan khusus untuk aplikasi OAuth daripada akun pribadi.

Daftarkan aplikasi OAuth

  1. Di Alat Pengembang Smartsheet, pilih Buat Aplikasi Baru.

  2. Lengkapi formulir:

    • Nama aplikasi — Nama untuk mengidentifikasi aplikasi Anda kepada pengguna.

    • Deskripsi aplikasi — Deskripsi singkat tentang integrasi.

    • URL Aplikasi — URL yang meluncurkan aplikasi Anda, atau halaman landing.

    • App contact/support - Support informasi kontak.

    • URL pengalihan aplikasi - https://{region}.quicksight.aws.amazon.com/sn/oauthcallback

      Ganti {region} dengan AWS Wilayah Anda (misalnya,us-east-1).

  3. Pilih Simpan. Smartsheet menghasilkan ID klien Aplikasi dan rahasia Aplikasi.

  4. Salin nilai Client ID dan Client Secret. Anda memerlukan ini saat mengonfigurasi integrasi di Amazon Quick.

Untuk informasi selengkapnya, lihat Mendaftarkan aplikasi di dokumentasi Smartsheet API.

Hasilkan token akses API (hanya otentikasi layanan)

Jika Anda berencana untuk menggunakan otentikasi layanan alih-alih OAuth, buat token akses API. Anda harus memiliki rencana Bisnis atau Perusahaan untuk menghasilkan token. Untuk informasi selengkapnya, lihat Menghasilkan token akses API di Pusat Bantuan Smartsheet.

  1. Di aplikasi Smartsheet, pilih Akun Anda (gambar profil) di bagian bawah bilah navigasi kiri, lalu pilih Pengaturan Pribadi.

  2. Pilih tab Akses API dan pilih Hasilkan token akses baru.

  3. Beri nama token dan pilih OK. Salin nilai token segera — ini adalah satu-satunya saat itu terlihat.

penting

Simpan token akses Anda dengan aman. Siapa pun yang memiliki token dapat mengakses semua data Smartsheet yang dapat diakses oleh pemilik token. Jangan komit token ke sistem kontrol versi. Untuk praktik terbaik dalam menyimpan token, lihat Autentikasi dalam dokumentasi API Smartsheet.

Cakupan akses OAuth

Saat Anda mengonfigurasi autentikasi pengguna (OAuth), integrasi meminta cakupan akses berikut dari Smartsheet. Cakupan ini menentukan apa yang dapat dilakukan integrasi atas nama pengguna yang diautentikasi. Jika Anda menggunakan otentikasi layanan (kunci API) sebagai gantinya, integrasi menggunakan izin penuh dari pemilik token dan cakupan tidak berlaku. Untuk informasi selengkapnya, lihat Akses cakupan dalam dokumentasi Smartsheet API.

Cakupan akses Smartsheet OAuth
Lingkup Deskripsi
READ_SHEETS Baca semua data lembar, termasuk lampiran, diskusi, dan data sel.
WRITE_SHEETS Menyisipkan dan memodifikasi data lembar, termasuk lampiran, diskusi, dan data sel.
catatan

Cakupan akses tidak mengesampingkan izin berbagi yang ada. Misalnya, memiliki WRITE_SHEETS cakupan tidak memungkinkan integrasi untuk memperbarui lembar di mana pengguna hanya memiliki akses tingkat pemirsa. Untuk informasi selengkapnya, lihat Tingkat akses sumber daya dalam dokumentasi Smartsheet API.

Siapkan integrasi di Amazon Quick

Setelah Anda menyelesaikan konfigurasi Alat Pengembang Smartsheet, buat integrasi di Amazon Quick.

  1. Di konsol Amazon Quick, pilih Konektor.

  2. Pilih tab Buat untuk tim Anda.

  3. Temukan dan pilih Smartsheet.

  4. Masukkan detail integrasi:

    • Nama — Nama deskriptif untuk integrasi Smartsheet Anda.

    • Deskripsi (Opsional) — Tujuan integrasi.

  5. Pilih jenis koneksi Anda dan isi pengaturan koneksi. Untuk informasi selengkapnya tentang metode otentikasi ini, lihatMetode autentikasi.

    1. Untuk autentikasi Pengguna (OAuth), gunakan ID Klien dan Rahasia Klien dari pendaftaran aplikasi Alat Pengembang Smartsheet Anda. Konfigurasi bidang berikut:

      • URL dasar — https://api.smartsheet.com/2.0

      • ID Klien — ID klien aplikasi dari pendaftaran aplikasi Smartsheet Developer Tools Anda.

      • Rahasia Klien — Rahasia aplikasi dari pendaftaran aplikasi Smartsheet Developer Tools Anda.

      • URL Token — https://api.smartsheet.com/2.0/token

      • URL Auth — https://app.smartsheet.com/b/authorize

      • URL pengalihan - https://{region}.quicksight.aws.amazon.com/sn/oauthcallback

    2. Untuk otentikasi Layanan (kunci API), gunakan token akses API dari Pengaturan Pribadi Smartsheet Anda. Konfigurasi bidang berikut:

      • Kunci API — Token akses API Smartsheet yang dihasilkan dari Pengaturan Pribadi Anda.

      • URL dasar — https://api.smartsheet.com/2.0

      • Email — Alamat email yang terkait dengan akun Smartsheet yang menghasilkan token.

  6. Pilih Buat dan lanjutkan.

  7. Pilih pengguna untuk berbagi integrasi dengan.

  8. Pilih Berikutnya.

Untuk otentikasi pengguna, buka Konektor > nama konektor Smartsheet Anda, dan pilih Masuk untuk menyelesaikan alur otorisasi OAuth. Di jendela persetujuan Smartsheet, pilih Izinkan untuk memberikan akses.

penting

Dengan otentikasi layanan, semua tindakan berjalan menggunakan izin pemilik token API. Setiap pengguna Amazon Quick dengan akses ke integrasi ini dapat melakukan tindakan pada semua sumber daya Smartsheet yang dapat diakses oleh pemilik token. Cakupan izin token dengan tepat untuk persyaratan keamanan organisasi Anda.

catatan

Jika Anda menggunakan Smartsheet Gov, Smartsheet Regions Europe, atau Smartsheet Regions Australia, gunakan URL dasar yang sesuai untuk lingkungan Anda:

URL dasar regional Smartsheet
Lingkungan URL dasar
Smartsheet https://api.smartsheet.com/2.0
Smartsheet Gubernur https://api.smartsheetgov.com/2.0
Wilayah Smartsheet Eropa https://api.smartsheet.eu/2.0
Wilayah Smartsheet Australia https://api.smartsheet.au/2.0

Untuk informasi selengkapnya, lihat URL dasar dalam dokumentasi Smartsheet API.

Tindakan yang tersedia

Setelah Anda mengatur integrasi, tindakan berikut tersedia.

Tindakan yang tersedia Smartsheet
Kategori Tindakan Deskripsi
Pencarian Daftar Pencarian Mencari semua lembar yang dapat diakses pengguna untuk teks tertentu.
Lembar Lembar Daftar Daftar semua lembar yang dapat diakses oleh pengguna yang diautentikasi.
Lembar Dapatkan Lembar Mendapat lembar dan datanya berdasarkan ID lembar.
Laporan Daftar Laporan Daftar semua laporan yang dapat diakses oleh pengguna.
Laporan Lihat Laporan Mendapat rincian laporan berdasarkan ID laporan.

Kelola dan pecahkan masalah

Untuk mengedit, membagikan, atau menghapus integrasi Anda, lihatMengelola integrasi yang ada.

Masalah otentikasi

  • Otorisasi OAuth gagal — Verifikasi bahwa ID Klien dan Rahasia Klien cocok dengan nilai dalam pendaftaran aplikasi Alat Pengembang Smartsheet Anda. Konfirmasikan URL pengalihan di Smartsheet cocok dengan URL dalam konfigurasi Amazon Quick Anda dengan tepat. Untuk daftar jenis kesalahan OAuth, lihat jenis kesalahan OAuth dalam dokumentasi API Smartsheet.

  • Alat Pengembang tidak tersedia — Verifikasi bahwa Alat Pengembang diaktifkan untuk akun Smartsheet Anda. Akun gratis tidak mendukung Alat Pengembang. Jika permintaan Anda ditolak, hubungi Manajer Sukses Pelanggan Smartsheet Anda.

  • Otentikasi kunci API gagal — Verifikasi bahwa token akses belum dicabut. Anda dapat mengelola token dari Pengaturan Pribadi > Akses API di aplikasi Smartsheet. Untuk informasi selengkapnya, lihat Menghasilkan token akses API di Pusat Bantuan Smartsheet.

  • Token akses kedaluwarsa — Token akses OAuth kedaluwarsa setelah sekitar 7 hari. Amazon Quick menangani penyegaran token secara otomatis. Jika Anda mengalami kesalahan token persisten, keluar dan masuk lagi dari pengaturan integrasi. Untuk informasi selengkapnya, lihat Melakukan panggilan API di dokumentasi Smartsheet API.

Pesan kesalahan umum

  • Tindakan mengembalikan kesalahan izin — Verifikasi bahwa pengguna yang diautentikasi memiliki izin berbagi yang diperlukan pada lembar target. Cakupan OAuth tidak mengesampingkan kontrol akses tingkat berbagi. Untuk informasi selengkapnya, lihat Tingkat akses sumber daya dalam dokumentasi Smartsheet API.

  • Lembar tidak ditemukan - Verifikasi ID lembar sudah benar dan bahwa pengguna yang diautentikasi memiliki setidaknya akses penampil ke lembar.

  • Kesalahan batas tingkat API — API Smartsheet memberlakukan batas tarif. Untuk informasi selengkapnya, lihat Batasan dalam dokumentasi API Smartsheet.