Kunci API

Diperbarui

Lokasi: Pengaturan > Integrasi > Kunci API

Kegunaan:

"Berikan program eksternal kunci tersendiri untuk mengirim melalui SyBox — token WhatsApp tidak pernah keluar dari server, dan kunci yang bocor dicabut secara terpisah." ERP, point of sale, atau program desktop Anda menggunakan kunci SyBox. Kredensial WhatsApp asli Anda tidak pernah dibutuhkan.

Hal yang dapat dilakukan program dengan kunci (dijelaskan di halaman Dokumentasi Developer publik):

  • Mengirim pesan WhatsApp dari nomor terhubung Anda sendiri. Menggunakan format permintaan yang sama seperti WhatsApp Cloud API milik Meta, jadi program yang sudah dibuat untuk itu hanya memerlukan alamat baru dan kunci SyBox. Teks, template, gambar, dokumen, dan pesan interaktif semuanya berfungsi. Jawaban dan kesalahan diterima persis seperti yang diberikan Meta.
  • Membuat kasus dari sistem Anda sendiri, misalnya keluhan yang dicatat di ERP Anda. Pelanggan harus sudah ada di SyBox.
  • Mengimpor SMS dari ponsel ke kotak masuk.

Siapa yang dapat membukanya: admin utama, dan anggota tim dengan izin "Kelola nomor WhatsApp".

Tombol pengalih "Gateway API":

Di bagian atas layar Kunci API terdapat pengalih bernama "Gateway API". Pengalih ini nonaktif secara default. Selama nonaktif, tidak ada kunci yang berfungsi dan Anda tidak dapat membuat kunci baru. Jika Anda mencoba, Anda akan melihat "Gateway API dinonaktifkan. Aktifkan dengan pengalih di bagian atas layar ini sebelum membuat kunci." Pengalih langsung tersimpan saat Anda mengekliknya.

Cara mengaktifkan gateway dan membuat kunci

  1. Buka Pengaturan > Integrasi > Kunci API.
  2. Aktifkan pengalih "Gateway API".
  3. Klik "Kunci baru".
    Settings, API keys: keys that let another program send through SyBox, and the "New key" button
  4. Pilih "Tipe kunci":
    • "Kirim melalui WhatsApp": program mengirim pesan ke pelanggan Anda.
    • "Buat kasus": program membuka kasus di SyBox. Program tidak dapat mengirim pesan.
    • "Impor SMS dari ponsel": ponsel meneruskan pesan SMS-nya ke kotak masuk.
  5. Isi "Nama perangkat atau program", misalnya "Desktop kantor" atau "Sistem akuntansi". Berikan kunci tersendiri untuk setiap perangkat atau program.
  6. Untuk kunci "Kirim melalui WhatsApp", atur juga:
    • "Kirim dari": nomor WhatsApp pengirim untuk kunci ini (wajib).
    • "Izinkan pesan teks bebas": aktif atau nonaktif.
    • "Izinkan template yang disetujui": aktif atau nonaktif. Setidaknya salah satu dari keduanya harus aktif, atau Anda akan melihat "Izinkan setidaknya salah satu dari teks bebas atau template — jika tidak, kunci tidak dapat mengirim apa pun."
    • "Izinkan pengiriman media": aktif atau nonaktif.
    • "Template" (opsional): nama template, dipisahkan dengan koma. Kosongkan untuk mengizinkan template apa pun.
    • "Negara penerima yang diizinkan" (opsional): kode negara dua huruf, misalnya MA,FR,EG. Kosongkan untuk mengizinkan negara mana pun.
    • "Pengiriman diizinkan dari" ... "Kepada": jam ketika kunci boleh mengirim. Biarkan keduanya sama jika tidak ada batas waktu. Waktu disesuaikan dengan jam lokal ruang kerja.
    • "Batas pesan harian (0 = tidak terbatas)".
  7. Untuk kunci "Impor SMS dari ponsel", atur "Hanya kontak dan pelanggan". Saat aktif, SMS dari nomor lain akan tetap berada di ponsel dan tidak pernah masuk ke kotak masuk. Nonaktifkan hanya jika ponsel tersebut khusus digunakan untuk kerja saja.
  8. Klik Simpan.
  9. Sebuah jendela menampilkan "URL Dasar" dan "Kunci API". Salin sekarang. "Salin kunci ini sekarang — hanya ditampilkan sekali." Masukkan ke dalam pengaturan program Anda.

Informasi yang ditampilkan kartu kunci:

  • Nama kunci, dan nomor pengirimnya (atau lencana tipenya, untuk kunci yang tidak mengirim).
  • Karakter terakhir kunci, sehingga Anda dapat membedakan antar-kunci.
  • "terakhir digunakan", dengan tanggal dan waktu, atau "tidak pernah".
  • Batasan apa pun yang aktif: "Hanya teks bebas", "Hanya template", "tanpa media", "Template", negara yang diizinkan, jam pengiriman, dan batas harian yang ditampilkan sebagai terkirim hari ini / batas / hari. Kunci SMS yang menerima semua nomor menampilkan "Semua nomor".

Cara mengubah, menjeda, atau menghapus kunci

  1. Klik Edit pada kartu kunci. Anda dapat mengubah nama, nomor, dan batasannya. Tipe kunci tidak dapat diubah setelah dibuat, dan kunci itu sendiri tidak akan pernah ditampilkan lagi.
    To change, pause or delete a key: "Edit" marked on the screen in SyBox
  2. Klik Aktifkan / Nonaktifkan untuk menghentikan kunci sementara waktu.
  3. Klik Hapus, lalu konfirmasi: "Hapus kunci API ini? Program apa pun yang masih menggunakannya akan langsung berhenti berfungsi."
Kunci API saya hilang. Bisakah saya melihatnya lagi?

Tidak. Kunci hanya ditampilkan sekali. Buat kunci baru, masukkan ke program Anda, lalu hapus kunci lama.

Sepertinya kunci saya bocor. Apa yang harus saya lakukan?

Hapus kunci tersebut, atau nonaktifkan, segera. Hanya kunci itu yang berhenti berfungsi. Nomor WhatsApp dan kunci Anda yang lain tidak terpengaruh.

Daftar "Kirim dari" kosong.

Daftar tersebut hanya menampilkan nomor WhatsApp yang terhubung dan aktif. Hubungkan nomor terlebih dahulu, di Pengaturan > Pesan > Saluran.

Program saya ditolak saat mengirim.

Pastikan pengalih "Gateway API" aktif dan kunci dalam keadaan aktif. Periksa juga batasan kunci: teks bebas vs template, media, template yang diizinkan, negara yang diizinkan, jam pengiriman, dan batas harian. Aturan WhatsApp sendiri juga tetap berlaku. Misalnya, teks bebas hanya berfungsi dalam waktu 24 jam sejak pesan terakhir pelanggan.

Bisakah kunci "Buat kasus" juga mengirim pesan?

Tidak, memang sengaja dirancang begitu. Kunci pembuat kasus tidak dapat mengirim pesan ke pelanggan, dan kunci pengirim tidak dapat membuat kasus. Gunakan kunci terpisah untuk setiap tugas.

Saya memiliki kunci lama bertipe "Terima dari program". Apakah masih berfungsi?

Ya, kunci lama dengan tipe tersebut tetap berfungsi. Kunci baru dengan tipe itu sudah tidak dapat dibuat lagi. Gunakan "Buat kasus" untuk tugas semacam itu.