Memulai

Tutorial ini memberikan informasi tentang cara menyiapkan klien On-Premises API, mendaftarkan nomor telepon, memperbarui pengaturan Anda, dan mengirimkan pesan pengujian.

Proses memulai API dapat dibagi menjadi 3 bagian:

1. Menyiapkan aset—Sebelum memulai, Anda harus menyiapkan aset yang diperlukan untuk menyelesaikan integrasi API Anda, termasuk Akun WhatsApp Business .
2. Instal Klien On-Premises API—Instal klien API. Setelah klien Anda bekerja, Anda bisa memperbarui pengaturan aplikasi Anda.
3. Mulai menggunakan klien—Daftarkan nomor telepon Anda dengan panggilan API ke /account dan kirim pesan uji dengan panggilan ke /messages.

Sebelum Memulai

Rekomendasi Versi Perangkat Lunak

Langkah 1: Instal Klien On-Premises API

Lingkungan

Pada intinya, klien On-Premises API didasarkan pada Docker. Lihat Arsitektur Klien untuk informasi tentang masing-masing komponen.

Peralatan

Klien On-Premises API akan dijalankan pada mesin yang terkoneksi internet yang dapat menjalankan Docker untuk Linux, baik di mesin virtual, atau pada server Linux. Untuk informasi selengkapnya, lihat Pertanyaan Umum. Sebagai contoh, pengujian sederhana dapat dilakukan di laptop. Untuk server lingkungan produksi, kami menyarankan setidaknya SSD 250 GB, RAM 16 GB, dan CPU 4 core. HDD tidak disarankan karena kecepatan I/O akan mengakibatkan kemacetan ketika terdapat muatan.

Dalam kebanyakan kasus, Anda sebaiknya menjalankan database di server fisik yang terpisah dari kontainer CoreApp dan WebApp. Latensi server database seharusnya hanya beberapa milidetik dari mesin komputasi.

Penginstalan

Ada dua cara untuk mulai menggunakan On-Premises API:

• Penginstalan di lokasi — Anda dapat menyiapkan kontainer Docker sendiri menggunakan panduan Penginstalan. Kami rekomendasikan untuk memulai dengan salah satu dari Pengaturan Developer untuk membiasakan diri dengan proses pengaturan dan pengiriman pesan. Solusi di Lokasi dapat digunakan di komputer sebelum memigrasi ke lingkungan produksi.
• Amazon Web Services (AWS): Jika Anda menggunakan AWS atau menginginkan solusi yang lebih mandiri, lihat panduan AWS. Solusi AWS menyiapkan solusi On-Premises API menyeluruh dengan cadangan, pemulihan, dan lain-lain di AWS cloud yang Anda kelola dan miliki.

Memperbarui Pengaturan Anda

Anda dapat membuat perubahan pada Pengaturan Aplikasi setelah klien On-Premises API berjalan. Akan tetapi, Anda tidak akan memiliki akses ke berbagai pengaturan profil klien On-Premises API sampai pendaftaran selesai.

• Pengaturan Aplikasi menentukan cara kerja klien — pengaturan callback, Webhook, on-call pager, status terkirim, perilaku pengunduhan media, dsb. Catatan: Anda sangat direkomendasikan untuk menyiapkan URL Webhook untuk menerima notifikasi tentang pesan dan kesalahan yang masuk.
• Pengaturan Profil Bisnis dan Pengaturan Profil mencakup informasi bisnis Anda, seperti alamat, email, situs web, industri, informasi tentang, dan foto profil.

Langkah 2: Mulai Menggunakan Klien

Pendaftaran

Setelah klien On-Premises API berjalan, Anda dapat mendaftarkan nomor telepon Anda dengan mengirimkan panggilan API ke endpoint account.

Mengirimkan Pesan Uji

Anda juga dapat mengirimkan pesan uji menggunakan endpoint messages. Pertama, cek status nomor telepon yang Anda gunakan untuk pengujian. Anda akan harus mengirimi akun WhatsApp Anda pesan dari nomor telepon pengujian untuk memungkinkan jendela Layanan Pelanggan, yang membuat Anda dapat mengirimkan pesan jenis apa pun dalam jendela 24 jam (Lihat Kontrol Pemutusan untuk detailnya). Kemudian, kirimkan pesan teks ke nomor telepon pengujian Anda. Jika pesan sampai, berarti penginstalan telah berhasil. Jika tidak sampai, periksa Webhooks Anda untuk membaca notifikasi yang mungkin menunjukkan masalahnya.

Keamanan

Lihat panduan Keamanan kami untuk informasi tentang kata sandi, autentikasi, konfigurasi SSL, pemisahan jaringan, komunikasi terenkripsi, header HTTP, dan protokol TLS server web yang terkait dengan klien On-Premises API.

Proses Pengaturan

On-Premises API WhatsApp menjalani prosedur mulai setelah membangun koneksi dengan server. Proses ini sangat penting untuk memastikan cara mengirim dan menerima lancar yang mulus dan dapat diandalkan. Selama fase mulai ini, aplikasi inti (CoreApp) menunggu pemenuhan beberapa prasyarat, termasuk:

• Memuat Pesan Template: API memuat pesan templat dari server sebagai bagian dari proses inisialisasi.

• Menerima dan Memproses Pesan Offline: CoreApp juga menangani penerimaan dan pemrosesan pesan offline.

Jika upaya untuk mengirim pesan dilakukan sementara prasyarat ini tidak terpenuhi, aplikasi inti akan menanggapi dengan pesan kesalahan "Coreapp belum siap", dan log akan menampilkan pesan kesalahan "Layanan belum siap". Penting untuk diperhatikan bahwa proses mulai ini dijalankan setiap kali koneksi baru dibuat dengan server WhatsApp. Akibatnya, jika aplikasi inti dimulai ulang atau koneksinya terputus, proses mulai akan dimulai lagi untuk mengatur status CoreApp menjadi "siap." Hal ini memastikan keandalan dan kesiapan On-Premises API WhatsApp untuk komunikasi pesan.

Pemrosesan Pesan Offline

Jika tidak ada pesan offline yang ditemukan, langkah pemrosesan pesan offline diabaikan. Dengan kata lain, jika tidak ada pesan yang menunggu dalam keadaan offline, fase tertentu penanganan pesan ini dilewati.

Dalam kondisi biasa, On-Premises API WhatsApp mengikuti protokol standar untuk menangani pesan offline. Ini menunggu penerimaan dan pemrosesan semua pesan offline, dengan ketentuan maksimum waktu habis 6 menit. Setelah durasi 6 menit ini berlalu, fase pemrosesan pesan offline dianggap berhasil diselesaikan.

Saran Tambahan

Jika kami mendeteksi bahwa Anda melanggar pedoman atau kebijakan kami, kami berhak untuk membatasi atau menghapus akses Anda ke WhatsApp.

Pelajari Selengkapnya

• Pengaturan Lanjutan
• Koleksi Postman
• Platform WhatsApp Business
• Catatan Perubahan Platform WhatsApp Business