API di Tempat Platform WhatsApp Business

Login

/v1/users/login

Untuk mengautentikasi diri Anda dengan klien API WhatsApp Business, Anda harus login. Untuk login, kirimkan nama pengguna dan kata sandi melalui autentikasi dasar dan terima token pembawa sebagai tanggapannya. Kemudian gunakan token pembawa untuk autentikasi saat mengirimkan permintaan ke endpoint API WhatsApp Business. Pelajari selengkapnya tentang autentikasi untuk menggunakan API.

Sebelum Memulai

Klien API WhatsApp Business memiliki akun default — nama pengguna akun admin dan kata sandinya secret. Akun ini tidak dapat dihapus dari sistem. Untuk alasan keamanan, Anda perlu mengubah kata sandi admin saat login pertama.

Rekomendasi Kata Sandi

Kami rekomendasikan untuk menggunakan kata sandi yang kuat saat membuat akun baru dan saat mengatur kata sandi akun baru, sesuai praktik terbaik industri.

Kata sandi harus berisi 8 hingga 64 karakter dan memiliki jumlah minimal:

  • satu digit
  • satu karakter huruf besar
  • satu karakter huruf kecil
  • satu karakter khusus dari!"#$%&\'()*+,-./:;<=>?@[]^_`{|}~

Kompleksitas kata sandi diberlakukan setelah membuat akun baru atau mengubah kata sandi akun yang sudah ada.

Membuat

Anda mengautentikasi diri Anda dengan menggunakan autentikasi dasar (nama pengguna, kata sandi) saat login. Authorization diatur di header HTTP. type adalah Basic dan credentials adalah string berenkode base64 yang terdiri dari username dan password yang digabungkan dengan titik dua (yaitu, username:password).

Saat permintaan login Anda diterima klien API WhatsApp Business, kredensial Anda diproses untuk validasi.

  • Jika berhasil, token Anda akan dibuat. Tanggapannya berisi token Anda di kolom token.
  • Jika tidak berhasil, kesalahan akan ditampilkan.

Contoh

Login Pertama

Untuk tujuan keamanan, Anda perlu memperbarui kata sandi admin default ke kata sandi baru dengan menggunakan kolom new_password pertama kali Anda mencoba login. Jika Anda mencoba login dengan kata sandi default dan tidak ada informasi kolom new_password, sistem akan menampilkan kesalahan.

Lihat kata sandi untuk rekomendasi kami. Login pertama Anda akan terlihat seperti berikut:

  POST /v1/users/login
  Authorization: Basic base64(username:password)
  {
  "new_password": "new-password"
  }

Versi cURL akan terlihat seperti ini:

curl -k -X POST https://your-webapp-hostname:your-webapp-port/v1/users/login \
  -w "\n%{http-code}\n" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Basic base64(username:password)' \
  -d '{"new_password" : "new-password"}'

Login Standar

Login standar untuk klien WhatsApp Business API terlihat seperti ini:

POST /v1/users/login
Authorization: Basic base64(username:password)

Versi cURL akan terlihat seperti ini:

curl -X POST \
  -H 'Authorization: Basic base64(username:password)' \
  -H 'Content-Type: application/json' \
  -d '{}' \
  https://your-webapp-hostname:your-webapp-port/v1/users/login

Jika berhasil, status 200 OK dikembalikan, bersama dengan token dan masa kedaluwarsa token. Semua token yang dibuat akan kedaluwarsa dalam 7 hari. Tanggapannya akan terlihat seperti contoh berikut:

{
   "users": [{
      "token": "eyJhbGciOHlXVCJ9.eyJ1c2VyIjoNTIzMDE2Nn0.mEoF0COaO00Z1cANo",
      "expires_after": "2018-03-01 15:29:26+00:00"
   }]
}

Jika permintaan tidak berhasil, Anda akan melihat status HTTP 401 Unauthorized. Kesalahan ini umumnya berarti bahwa nama pengguna dan/atau kata sandi yang dikirimkan dengan permintaan login tidak valid, sehingga klien API WhatsApp Business tidak dapat membuat token.

Jika ada kesalahan dalam tanggapan, lihat berikut ini untuk informasi lebih lanjut: Kode Kesalahan Klien WhatsApp Enterprise dan Kode Status HTTP.

Kolom yang Ditampilkan

Kolom Deskripsi

token

Wajib.

Token autentikasi akan digunakan untuk semua panggilan API WhatsApp Business lainnya. Token harus dikirimkan di header otorisasi dengan format:
Authorization: Bearer <authentication-token>

expires_after

Wajib.

Cap waktu kedaluwarsa token. Secara default, kedaluwarsanya 7 hari.

Pelajari selengkapnya