Untuk developer

Platform API

Platform API Wavely memungkinkan aplikasi Anda mengelola bisnis, cabang, tim, dan anggotanya dari server Anda, tanpa membuka dashboard.

Apa yang bisa dilakukan API

Platform API dipakai aplikasi Anda dari server ke server, di bawah /platform/v1. Dengannya aplikasi Anda mengatur Wavely tanpa membuka dasbor:

  • bisnis milik aplikasi Anda beserta pengaturannya, cabang, dan tim (disebut divisi di API)
  • anggota (agen), pengaturan routing dan visibilitasnya
  • kontak dan persetujuan WhatsApp mereka
  • kanal, nomor WhatsApp, balasan cepat, dan event balasan cepat
  • percakapan dan pesan: mengirim pesan WhatsApp, membaca riwayat, mengunggah berkas
  • endpoint webhook dan sesi komponen tertanam

Aplikasi hanya melihat bisnis yang dibuatnya sendiri.

Memulai

  1. Aplikasi Anda didaftarkan oleh tim Wavely. Anda menerima kunci publik wvpk_... untuk komponen tertanam, dan satu atau lebih kunci rahasia wvsk_....
  2. Setiap kunci rahasia membawa scope, seperti directory:read, contacts:write, messages:write, webhooks:manage, dan embed:sessions. Rahasia kunci hanya tampil sekali, saat dibuat atau diputar. Simpan di tempat aman.
  3. Kirim kunci di header Authorization. Rute yang bekerja pada satu bisnis juga meminta header Wavely-Organization.
curl https://HOST-WAVELY/platform/v1/branches \
  -H "Authorization: Bearer wvsk_..." \
  -H "Wavely-Organization: ID-BISNIS"

Kunci tanpa scope yang diminta rute mendapat 403 insufficient_scope, dan details.required_scope menyebut scope yang kurang.

Aturan permintaan

  • Permintaan POST yang membuat sesuatu wajib membawa Idempotency-Key. Mengulang permintaan yang sama dengan kunci yang sama mengembalikan jawaban yang sama, bukan data ganda.
  • Perubahan pada data bernomor versi (cabang, tim, agen, kontak, kanal, dan lainnya) wajib membawa If-Match berisi versi dari ETag. Versi yang basi menghasilkan 412, dan header yang hilang 428.
  • Daftar memakai cursor dan limit (1 sampai 100), dan menjawab { items, next_cursor }.
  • Galat berbentuk { "error": { "code", "message", "details" } }. Jawaban 429 menyertakan Retry-After.

Catatan: Lihat juga halaman Webhook untuk menerima kabar perubahan, dan Komponen tertanam untuk menampilkan layar Wavely di aplikasi Anda.