Kunci API · Bantuan Measure Map Online

Buat kunci yang menghubungkan situs web atau perangkat lunak Anda ke Measure Map Online, pilih apa yang boleh dilakukannya, pisahkan pekerjaan live dan uji coba, serta ganti atau batasi kunci dengan aman.

Kunci API memungkinkan situs web atau perangkat lunak Anda sendiri bekerja dengan akun Measure Map Online Anda: menampilkan peta sebuah proyek di situs Anda, memulai proyek untuk pengunjung Anda, atau membaca dan mengubah proyek melalui REST API. Anda membuat dan mengelola kunci di halaman Pengembang.

Buka halaman Pengembang#

Di menu dasbor, di bawah Lanjutan, tekan Pengembang. Halaman ini terbuka pada Kunci API, dan bagian-bagian lainnya tercantum di bawahnya di menu (di ponsel, sebagai tab di bagian atas halaman):

Tautan tamu (Open Guest): tautan tanpa kode untuk situs web Anda. Lihat Open Guest.
Coba API, Webhook, dan REST API: lihat referensi API.
Sematkan peta (Enterprise): lihat iFrame API.

Lencana di bagian atas kartu kunci menunjukkan apakah kunci Anda Aktif, Tidak aktif (belum ada kunci), Nonaktif (akses API ditangguhkan: tidak ada kunci yang berfungsi dan kunci baru tidak dapat dibuat sampai tim dukungan mencabut penangguhannya), atau Kedaluwarsa (langganan tidak aktif).

Bagian Kunci API dengan kunci Sandbox, apa yang dapat dilakukannya, dan tombol untuk menampilkan dan menyalinnya

Live dan Sandbox#

Di bagian atas kartu kunci, beralihlah antara Live dan Sandbox. Masing-masing memiliki kuncinya sendiri, dan halaman ini menampilkan kunci yang Anda pilih. Pilihan ini juga berlaku di Coba API, dan tetap berlaku saat Anda berpindah antarbagian. Sematkan peta dan Tautan tamu selalu memakai kunci live Anda, karena pengunjung situs web Anda hanya dapat membuka proyek live: membuka salah satunya mengembalikan halaman ke Live.

Live adalah akun Anda yang sebenarnya, dan halaman ini terbuka padanya. Gunakan kunci live di situs web Anda.
Sandbox untuk membangun dan menguji integrasi. Proyek, folder, dan produk yang dibuat dengan kunci sandbox disimpan terpisah dari yang sebenarnya: kunci live tidak dapat melihatnya, dan kunci sandbox tidak dapat melihat yang live. Permintaan yang dibuat dengan kunci sandbox tidak dihitung dalam angka penggunaan Anda, dan proyek tamu yang dibuat dengan kunci sandbox tidak pernah ditagih.

Membuat kunci sandbox baru tidak pernah memengaruhi kunci live Anda, begitu pula sebaliknya.

Pilih apa yang dapat dilakukan kunci#

Di Akses kunci baru, setiap baris adalah satu area API. Pilih seberapa jauh kunci berikutnya yang Anda buat dapat menjangkau area tersebut:

Area	Pilihan	Apa yang diizinkan
Peta tersemat	Tanpa akses, Diizinkan	Masukkan penonton ke peta tersemat. Sebagian besar integrasi hanya perlu ini.
Proyek	Tanpa akses, Baca, Baca & ubah	Proyek dan folder, beserta pengukuran, komentar, dan ekspornya.
Pengguna (Enterprise)	Tanpa akses, Baca, Baca & ubah	Orang-orang di akun Anda dan kursi mereka.
Produk	Tanpa akses, Baca, Baca & ubah	Katalog produk Anda dan harganya.

Arahkan penunjuk ke sebuah pilihan untuk melihat dengan tepat apa yang diberikannya. Kunci pertama Anda awalnya hanya memiliki Peta tersemat, yang merupakan satu-satunya hal yang dibutuhkan peta tersemat; kunci yang menggantikan kunci lain awalnya memiliki akses kunci tersebut. Pilih setidaknya satu area. Masuk sebagai salah satu anggota organisasi Anda melalui API membutuhkan Pengguna: Baca & ubah, bukan Peta tersemat.

Apa yang boleh dilakukan sebuah kunci ditetapkan saat Anda membuatnya. Untuk memberi kunci akses lebih banyak atau lebih sedikit, buat kunci baru.

Akses untuk kunci baru, satu baris per area API

Buat kunci#

Pilih Live atau Sandbox.
Atur aksesnya di Akses kunci baru.
Jika mau, ketik nama di Nama untuk kunci baru (opsional) agar kunci-kunci Anda mudah dibedakan.
Tekan Hasilkan kunci baru.

Kunci muncul di bawah Kunci API Anda, tersembunyi kecuali beberapa karakter pertama dan terakhirnya, dengan baris Izin yang menyebutkan apa yang dapat dilakukannya. Tekan untuk menampilkannya secara utuh, atau untuk menyalin seluruh kunci. Anda menerima email setiap kali sebuah kunci dibuat di akun Anda.

Kunci yang dibuat sebelum ada area akses dapat melakukan segalanya kecuali bekerja dengan produk dan masuk sebagai anggota; kartu ini memperingatkan Anda tentang hal itu. Ganti dengan kunci yang lebih terbatas jika Anda hanya menggunakannya untuk sematan.

Ganti kunci#

Tekan Hasilkan kunci baru lagi saat Anda sudah memiliki kunci. Aplikasi memperingatkan Anda terlebih dahulu: Kunci baru akan dibuat dan kunci Anda saat ini tetap berfungsi selama 24 jam, sehingga Anda dapat memperbarui situs yang menggunakannya. Anda dapat mencabutnya lebih awal setelah selesai.

Kunci lama berpindah ke Kunci sebelumnya, beserta sisa waktunya dan kapan terakhir kali digunakan. Masih diterima selama Anda menerapkan kunci baru. Cabut segera setelah tidak ada yang menggunakannya. Untuk menghentikannya seketika, tekan Cabut lalu konfirmasi; situs mana pun yang masih menggunakannya langsung berhenti berfungsi. Anda menerima email saat sebuah kunci dicabut.

Pembatasan situs web Anda disalin ke kunci baru. Anda dapat membuat kunci baru kira-kira sekali per menit.

Kunci sebelumnya yang masih diterima selama beberapa jam lagi, dengan tombol Cabut-nya

Batasi kunci ke situs web Anda#

Hanya situs web dalam daftar ini yang dapat menggunakan kunci Anda di browser: peta tersemat dan permintaan dari halaman situs lain akan ditolak. Panggilan dari server tidak terpengaruh.

Di Pembatasan website, ketik situs Anda di Masukkan website atau domain: domain seperti example.com, alamat IP, atau localhost. Anda dapat menempelkan alamat lengkap: hanya nama situsnya yang disimpan, tanpa https://, jalur, atau port.
Tekan Tambahkan.

Sebuah domain juga mencakup subdomainnya: example.com mengizinkan shop.example.com. Tekan untuk menghapus sebuah situs, lalu konfirmasi; setelah situs terakhir dihapus, kunci berfungsi dari situs web mana pun. Anda menerima email setiap kali sebuah situs web dihapus dari sebuah kunci.

Daftar ini berlaku untuk browser. Peta tersemat hanya terbuka di halaman situs web yang ada di daftar; jika browser tidak menyebutkan di halaman mana peta itu berada, peta ditolak. Permintaan REST API yang dikirim dari halaman web harus berasal dari situs web yang ada di daftar. Permintaan dari server Anda sendiri tidak menyebutkan situs web dan tidak diperiksa. Measure Map Online sendiri selalu diizinkan, sehingga pratinjau di halaman ini tetap berfungsi.

Pembatasan situs web dengan dua domain yang diizinkan

Lihat bagaimana kunci digunakan#

Penggunaan menjumlahkan semua kunci live Anda, sehingga angkanya berlanjut saat Anda mengganti kunci. Bagian ini menampilkan permintaan 30 hari terakhir, baik dari peta tersemat maupun REST API, dengan satu batang untuk setiap hari; total Sepanjang waktu; Akses terakhir; kapan kunci saat ini dibuat (Kunci dibuat); dan Domain teratas: situs web yang paling sering menggunakan kunci Anda. Situs web yang tidak Anda kenali di sana adalah alasan untuk membatasi atau mengganti kunci.

Permintaan sandbox tidak dihitung, sehingga angkanya hanya tampil di Live. Permintaan yang dibuat halaman ini sendiri, di Coba API dan pratinjau, juga tidak dihitung.

Jaga keamanan kunci Anda#

Beri setiap kunci hanya akses yang dibutuhkannya. Kunci di halaman web (misalnya di alamat sebuah sematan) sebaiknya hanya memiliki Peta tersemat.
Kunci ini dapat mengubah data Anda. Simpan di server Anda, jangan pernah di halaman web atau aplikasi.
Batasi kunci yang digunakan di halaman web ke situs web Anda sendiri.
Biarkan kunci tetap tersembunyi di halaman saat Anda berbagi layar; untuk menyalinnya, kunci tidak perlu ditampilkan.
Jika sebuah kunci mungkin bocor, segera buat kunci baru dan cabut kunci lama di Kunci sebelumnya.
Bangun dan uji dengan kunci Sandbox, agar percobaan tidak pernah tercampur dengan proyek Anda yang sebenarnya.