API Tại chỗ của Nền tảng WhatsApp Business

Đăng nhập

/v1/users/login

Để xác thực chính mình với ứng dụng API WhatsApp Business, bạn phải đăng nhập. Để đăng nhập, bạn cần gửi tên người dùng và mật khẩu của mình bằng phương thức xác thực cơ bản rồi nhận mã bearer trong phản hồi. Sau đó, bạn có thể dùng mã bearer này để xác thực khi gửi yêu cầu đến điểm cuối API WhatsApp Business bất kỳ. Tìm hiểu thêm về cách xác thực để sử dụng API này.

Trước khi bạn bắt đầu

Ứng dụng API WhatsApp Business có một tài khoản mặc định - tên người dùng của tài khoản này là admin và mật khẩu là secret. Bạn không thể gỡ hay xóa tài khoản này khỏi hệ thống. Vì lý do bảo mật, bạn cần phải đổi mật khẩu quản trị viên trong lần đăng nhập đầu tiên.

Đề xuất mật khẩu

Bạn nên sử dụng mật khẩu mạnh khi tạo tài khoản mới cũng như khi đặt mật khẩu cho tài khoản mới, theo cách làm tốt nhất trong ngành.

Mật khẩu cần có độ dài từ 8 đến 64 ký tự và có ít nhất:

  • một chữ số
  • một chữ cái viết hoa
  • một chữ cái viết thường
  • một ký tự đặc biệt trong số các ký tự !"#$%&\'()*+,-./:;<=>?@[]^_`{|}~

Độ phức tạp của mật khẩu được thực thi tùy theo việc bạn tạo tài khoản mới hay đổi mật khẩu của tài khoản hiện có.

Tạo

Bạn xác thực chính mình bằng phương thức xác thực cơ bản (tên người dùng, mật khẩu) khi đăng nhập. Authorization được đặt trong tiêu đề HTTP. type là Basic và credentials là một chuỗi được mã hóa base64 gồm username và password kèm theo dấu hai chấm (tức là username:password).

Khi ứng dụng API WhatsApp Business nhận được yêu cầu đăng nhập bạn gửi, hệ thống sẽ xử lý thông tin đăng nhập của bạn để xác thực.

  • Nếu thành công, hệ thống sẽ tạo mã cho bạn. Phản hồi sẽ chứa mã đó trong trường token.
  • Nếu không thành công, hệ thống sẽ trả về lỗi.

Ví dụ

Đăng nhập lần đầu

Vì mục đích bảo mật, bạn cần phải cập nhật mật khẩu quản trị viên mặc định thành mật khẩu mới thông qua trường new_password trong lần đăng nhập đầu tiên. Nếu bạn cố gắng đăng nhập bằng mật khẩu mặc định và không nhập thông tin vào trường new_password, hệ thống sẽ trả về lỗi.

Hãy xem phần mật khẩu để biết các đề xuất của chúng tôi. Tùy chọn đăng nhập lần đầu của bạn sẽ có dạng như sau:

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

Phiên bản cURL sẽ có dạng như sau:

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"}'

Đăng nhập tiêu chuẩn

Tùy chọn đăng nhập tiêu chuẩn cho ứng dụng API WhatsApp Business sẽ có dạng như sau:

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

Phiên bản cURL sẽ có dạng như sau:

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

Khi thành công, hệ thống sẽ trả về trạng thái 200 OK, cùng với mã và thời gian hết hạn của mã đó. Tất cả các mã được tạo sẽ hết hạn sau 7 ngày. Phản hồi sẽ có dạng như ví dụ dưới đây:

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

Nếu yêu cầu không thành công, bạn sẽ thấy trạng thái HTTP là 401 Unauthorized. Lỗi này thường do tên người dùng và/hoặc mật khẩu mà bạn gửi cùng với yêu cầu đăng nhập là không hợp lệ. Do đó, ứng dụng API WhatsApp Business không thể tạo mã.

Nếu phản hồi có lỗi, hãy tham khảo những phần sau để biết thêm thông tin: Mã lỗi của ứng dụng WhatsApp Enterprise và Mã trạng thái HTTP.

Trường được trả về

Trường Mô tả

token

Bắt buộc.

Mã xác thực sẽ được dùng cho mọi lệnh gọi API WhatsApp Business khác. Bạn phải gửi mã này trong tiêu đề ủy quyền theo định dạng sau:
Authorization: Bearer <authentication-token>

expires_after

Bắt buộc.

Nhãn thời gian hết hạn của mã. Theo mặc định, nhãn thời gian này là 7 ngày.

Tìm hiểu thêm