Menghubungkan Data Toko melalui Open API

Web Tingkat Lanjutan Peran Admin Modul Akun, Open API Estimasi 15 menit
Diperbarui

Open API membantu menghubungkan data toko dengan aplikasi lain. Admin toko dapat membuat API key dan memakai dokumentasi yang tersedia untuk menyiapkan sambungan sesuai kebutuhan.

Kapan dipakai:

  • Menghubungkan data toko dengan aplikasi lain.
  • Menyiapkan akses integrasi bersama pengembang yang Anda percaya.

Perlu diketahui:

  • Open API merupakan modul Premium.
  • Pengelolaan Open API hanya tersedia untuk admin toko melalui web.
  • Menu Open API berada setelah Asisten AI.
  • API key adalah kunci akses rahasia. Jangan menaruhnya di halaman publik atau membagikannya sembarangan.

Yang perlu disiapkan

  • Siapkan akun admin toko.
  • Pastikan modul Open API sudah aktif.
  • Tentukan data yang diperlukan aplikasi tujuan dan siapkan pihak yang akan mengerjakan integrasi.

Langkah-langkah

  1. Aktifkan modul Open API

    Buka pengelolaan modul akun dan aktifkan modul Premium Open API untuk toko yang akan dihubungkan. Periksa status modul sebelum melanjutkan ke web toko.

  2. Buka Open API sebagai admin

    Masuk ke web toko dengan akun admin lalu buka Open API. Cari menu ini setelah Asisten AI.

    Halaman Open API di web toko dengan status modul, batas pemakaian, Dokumentasi API, dan Buat kunci baru
    Buka Open API melalui web menggunakan akun admin toko.
  3. Baca dokumentasi yang disediakan

    Buka dokumentasi dari halaman Open API. Cocokkan kebutuhan aplikasi tujuan dengan layanan dan petunjuk akses yang tercantum. Jangan menganggap semua data atau tindakan tersedia tanpa memeriksa dokumentasi.

    Dokumentasi Open API berisi layanan dan petunjuk akses untuk integrasi
    Cocokkan kebutuhan aplikasi tujuan dengan dokumentasi yang tersedia.
  4. Buat API key untuk sambungan

    Gunakan fungsi pembuatan API key pada halaman Open API dan ikuti isian yang tersedia. Simpan kunci secara aman untuk dipakai oleh aplikasi tujuan. Catatan: Berikan kunci hanya kepada pihak yang berwenang mengerjakan sambungan.

    Halaman Open API dengan fungsi pembuatan API key
    Simpan API key secara aman dan jangan tampilkan kunci dalam tangkapan layar.
  5. Siapkan dan periksa integrasi

    Pasang kunci pada pengaturan rahasia aplikasi tujuan sesuai dokumentasi. Periksa hasil sambungan dan kecocokan data sebelum dipakai untuk pekerjaan harian. Tips: Hindari menampilkan kunci dalam tangkapan layar, pesan grup, atau dokumen yang dapat diakses umum.

Hasil akhir

Modul Open API sudah aktif dan API key tersedia untuk menyiapkan integrasi mengikuti dokumentasi resmi.

Kalau ada kendala

Menu Open API tidak terlihat

Pastikan modul aktif untuk toko yang benar dan Anda masuk sebagai admin melalui web.

Kebutuhan integrasi belum jelas

Periksa dokumentasi bersama pengembang sebelum menyusun sambungan. Jangan menebak layanan atau format akses.

API key terlanjur dibagikan

Hentikan penyebaran kunci dan minta admin memeriksa penanganan kunci pada halaman Open API atau melalui bantuan Automan.