Bản dịch sang Tiếng Việt chưa hoàn tất.
Tổng quan
Với API Quản lý doanh nghiệp, bạn có thể tạo và quản lý các tài sản doanh nghiệp liên quan đến WhatsApp, chẳng hạn như Tài khoản WhatsApp Business và mẫu tin nhắn. API này được xây dựng dựa trên API Marketing và tận dụng một số điểm cuối của API Marketing. Vì vậy, tài liệu này có thể chứa các liên kết đến tài liệu về API Marketing nếu thích hợp.
Yêu cầu
- Tài khoản kinh doanh trên Meta.
- Tài khoản WhatsApp Business được liên kết với Tài khoản kinh doanh trên Meta của bạn.
- Ứng dụng kinh doanh được liên kết với Tài khoản kinh doanh trên Meta của bạn.
- Quyền whatsapp_business_management.
- Nếu ứng dụng truy cập vào các điểm cuối nhắm đến Tài khoản kinh doanh trên Meta của bạn, bạn sẽ cần có quyền business_management.
- Nếu ứng dụng truy cập vào các điểm cuối API Đám mây, bạn sẽ cần có quyền whatsapp_business_messaging.
Mã truy cập
Nền tảng này hỗ trợ các loại mã truy cập sau. Loại mã truy cập được sử dụng phụ thuộc vào đối tượng sẽ dùng ứng dụng của bạn và liệu bạn có phải là Nhà cung cấp giải pháp hay không.
- Nếu bạn là nhà phát triển trực tiếp - tức là chỉ bạn hoặc doanh nghiệp của bạn truy cập vào dữ liệu của chính mình, hãy sử dụng mã truy cập dành cho Người dùng hệ thống.
- Nếu bạn là Nhà cung cấp công nghệ, hãy sử dụng mã truy cập dành cho Người dùng hệ thống của Tiện ích tích hợp cho doanh nghiệp.
- Nếu bạn là Đối tác giải pháp, hãy sử dụng mã truy cập dành cho Người dùng hệ thống để chia sẻ hạn mức tín dụng của mình với khách hàng mới tích hợp và sử dụng mã truy cập dành cho Người dùng hệ thống của Tiện ích tích hợp cho doanh nghiệp cho các trường hợp khác.
Mã truy cập dành cho Người dùng hệ thống
Mã truy cập dành cho Người dùng hệ thống đại diện cho bạn, doanh nghiệp/tổ chức của bạn hoặc những người trong doanh nghiệp/tổ chức của bạn. Các mã này có ưu điểm chính là không hết hạn và có thể đại diện cho những dịch vụ tự động trong doanh nghiệp của bạn mà không yêu cầu bất kỳ dữ liệu đầu vào nào của người dùng.
Mã truy cập dành cho Người dùng hệ thống là loại mã duy nhất mà Đối tác giải pháp có thể dùng để chia sẻ hạn mức tín dụng với khách hàng đã tích hợp.
Bạn phải tạo người dùng hệ thống thì mới có thể tạo mã truy cập dành cho Người dùng hệ thống. Hầu hết các điểm cuối đều kiểm tra xem người dùng được xác định bằng mã này có quyền truy cập vào tài nguyên được truy vấn hay không. Nếu người dùng không có quyền truy cập vào tài nguyên đó, yêu cầu sẽ bị từ chối kèm theo mã lỗi 200.
Người dùng hệ thống có thể là nhân viên hoặc quản trị viên.
Người dùng hệ thống là nhân viên
Người dùng hệ thống là nhân viên phải được cấp quyền truy cập vào từng Tài khoản WhatsApp Business thuộc sở hữu của hoặc được chia sẻ với doanh nghiệp trên Meta. Nếu ứng dụng của bạn sẽ chỉ truy cập vào một số Tài khoản WhatsApp Business mà bạn sở hữu, bạn chỉ cần sử dụng người dùng hệ thống là nhân viên.
Sau khi tạo, bạn phải cấp Quyền truy cập một phần hoặc Toàn quyền truy cập vào tài sản doanh nghiệp đối với từng Tài khoản WhatsApp Business mà người dùng hệ thống cần truy cập.
Người dùng hệ thống là quản trị viên
Theo mặc định, người dùng hệ thống là quản trị viên có toàn quyền truy cập vào mọi Tài khoản WhatsApp Business và tài sản thuộc sở hữu của hoặc được chia sẻ với bạn hoặc doanh nghiệp của bạn.
Người dùng hệ thống là quản trị viên sẽ hữu ích nếu ứng dụng của bạn cần truy cập vào Tài khoản WhatsApp Business mới được chia sẻ với doanh nghiệp bạn. Nếu đang sử dụng người dùng hệ thống là nhân viên, bạn phải cấp quyền truy cập tài sản doanh nghiệp theo cách thủ công cho từng Tài khoản WhatsApp Business đã được chia sẻ với mình.
Lưu ý rằng bạn có thể ghi đè quyền truy cập tài sản doanh nghiệp mặc định của người dùng hệ thống là quản trị viên bằng cách cấp quyền truy cập một phần cho từng Tài khoản WhatsApp Business. Hãy xem phần Quyền truy cập tài sản doanh nghiệp để tìm hiểu cách đặt và ghi đè quyền truy cập.
Tạo người dùng hệ thống
Cách tạo người dùng hệ thống như sau:
- Đăng nhập vào Meta Business Suite.
- Tìm tài khoản kinh doanh của bạn trong menu thả xuống ở trên cùng bên trái rồi nhấp vào biểu tượng Cài đặt (bánh răng).
- Nhấp vào Cài đặt cho doanh nghiệp.
- Điều hướng đến Người dùng > Người dùng hệ thống.
- Nhấp vào nút Thêm rồi tạo người dùng hệ thống là quản trị viên hoặc nhân viên.
Tạo mã truy cập dành cho Người dùng hệ thống
Cách tạo mã truy cập dành cho Người dùng hệ thống sau khi tạo người dùng hệ thống:
- Đăng nhập vào Meta Business Suite.
- Tìm tài khoản kinh doanh của bạn trong menu thả xuống ở trên cùng bên trái rồi nhấp vào biểu tượng Cài đặt (bánh răng).
- Nhấp vào Cài đặt cho doanh nghiệp.
- Điều hướng đến Người dùng > Người dùng hệ thống.
- Chọn người dùng hệ thống thích hợp từ danh sách người dùng hệ thống.
- Nhấp vào nút Tạo mã mới.
- Chọn ứng dụng sẽ sử dụng mã này.
- Chọn các quyền truy cập API Đồ thị mà ứng dụng cần để hoạt động chính xác và tạo mã.
Mã truy cập dành cho Người dùng hệ thống của Tiện ích tích hợp cho doanh nghiệp
Mã truy cập dành cho Người dùng hệ thống của Tiện ích tích hợp cho doanh nghiệp được cấp cho khách hàng cá nhân đã tích hợp. Nhà cung cấp công nghệ và Đối tác giải pháp cần sử dụng mã này khi truy cập vào dữ liệu của khách hàng đã tích hợp.
Bạn nên sử dụng những loại mã này cho ứng dụng thực hiện các hành động tự động, theo lập trình trên Tài khoản WhatsApp Business của khách hàng mà không phải dựa vào dữ liệu đầu vào của người dùng ứng dụng hoặc yêu cầu xác thực lại trong tương lai.
Để tạo mã truy cập dành cho Người dùng hệ thống của Tiện ích tích hợp cho doanh nghiệp, bạn phải triển khai quy trình Đăng ký được nhúng (đã đặt cấu hình thông qua phương thức Đăng nhập bằng Facebook cho doanh nghiệp), rồi trao đổi mã mà hệ thống trả về cho bạn khi khách hàng hoàn tất quy trình đó.
Hãy xem tài liệu về quy trình Đăng ký được nhúng và mã truy cập dành cho Người dùng hệ thống của Tiện ích tích hợp cho doanh nghiệp để tìm hiểu thêm về các mã này cũng như cách tạo mã.
Mã truy cập dành cho người dùng
Mặc dù tất cả nhà phát triển ứng dụng đều hỗ trợ và có thể sử dụng mã truy cập dành cho Người dùng, nhưng có khả năng bạn sẽ chỉ dùng mã này khi sử dụng Bảng điều khiển ứng dụng lần đầu để gửi tin nhắn thử nghiệm đầu tiên. Tuy nhiên, khi phát triển ứng dụng, nhiều khả năng bạn sẽ chuyển sang dùng mã truy cập dành cho Người dùng hệ thống (và cuối cùng là mã truy cập dành cho Người dùng hệ thống của Tiện ích tích hợp cho doanh nghiệp, nếu bạn là Nhà cung cấp công nghệ hoặc Nhà cung cấp giải pháp). Nguyên nhân là vì mã truy cập dành cho người dùng nhanh hết hạn, do đó, bạn sẽ phải tiếp tục tạo mã mới vài giờ một lần.
Có nhiều cách để tạo mã truy cập dành cho Người dùng:
- Truy cập bảng điều khiển Bảng điều khiển ứng dụng > WhatsApp > Thiết lập API. Bảng điều khiển này luôn tạo mã truy cập mới dành cho Người dùng mỗi khi bạn truy cập. Mã sẽ tự động được cấp cho người dùng của bạn vì bạn đã đăng nhập vào tài khoản nhà phát triển khi truy cập vào bảng điều khiển.
- Sử dụng Trình khám phá API Đồ thị.
- Triển khai phương thức Đăng nhập bằng Facebook.
Sử dụng mã trong yêu cầu
Khi gửi yêu cầu API, hãy thêm mã của bạn vào tiêu đề yêu cầu ủy quyền, có Bearer đứng trước. Ví dụ:
curl 'https://graph.facebook.com/v18.0/102290129340398/message_templates' \ -H 'Authorization: Bearer EAAJB...' \
Quyền truy cập tài sản doanh nghiệp
Sau khi tạo người dùng hệ thống, bạn phải đặt cấp độ truy cập tài sản doanh nghiệp. Nhiều điểm cuối yêu cầu người dùng hệ thống sở hữu mã có trong yêu cầu API phải có Quyền truy cập một phần hoặc Toàn quyền truy cập vào tài sản doanh nghiệp đối với Tài khoản WhatsApp Business đang được truy vấn (hoặc tài sản của tài khoản đó). Nếu người dùng hệ thống không có quyền truy cập này, các điểm cuối này sẽ trả về mã lỗi 200.
Lưu ý rằng nếu đặt quyền truy cập tài sản doanh nghiệp của người dùng hệ thống trên Tài khoản WhatsApp Business là Quyền truy cập một phần, bạn có thể tiếp tục hạn chế quyền truy cập ở một số tài sản hoặc hành động trên Tài khoản WhatsApp Business. Ví dụ: nếu có một doanh nghiệp lớn và muốn một bộ phận nhất định chỉ có quyền đọc dữ liệu mẫu và số điện thoại của doanh nghiệp thuộc Tài khoản WhatsApp Business, bạn có thể tạo người dùng hệ thống cho bộ phận đó và đặt quyền truy cập chi tiết thành chỉ xem đối với dữ liệu đó.
Cách đặt quyền truy cập tài sản doanh nghiệp trên Tài khoản WhatsApp Business:
- Đăng nhập vào Meta Business Suite.
- Tìm tài khoản kinh doanh của bạn trong menu thả xuống ở trên cùng bên trái rồi nhấp vào biểu tượng Cài đặt (bánh răng).
- Chuyển đến Tài khoản > Tài khoản WhatsApp.
- Chọn Tài khoản WhatsApp Business thích hợp.
- Chọn tab Quyền truy cập vào tài khoản WhatsApp.
- Nhấp vào nút +Thêm người.
- Chọn người dùng hệ thống thích hợp và chỉ định cấp độ truy cập phù hợp trên Tài khoản WhatsApp Business.
Thử nghiệm điểm cuối
Bạn nên sử dụng bộ sưu tập Postman của chúng tôi hoặc cURL khi thử nghiệm điểm cuối. Mặc dù bạn có thể sử dụng công cụ Trình khám phá API Đồ thị, nhưng công cụ này sẽ chuyển mã dưới dạng thông số chuỗi truy vấn. Chúng tôi không khuyến nghị phương thức này (hãy chuyển mã qua tiêu đề yêu cầu).
Lấy thông tin về một doanh nghiệp
Để lấy thông tin về một doanh nghiệp, hãy gửi yêu cầu GET đến điểm cuối WhatsAppBusinessAccount, trong đó <WHATSAPP_BUSINESS_ACCOUNT_ID> là ID tài khoản WhatsApp Business của bạn.
Yêu cầu mẫu
curl -i -X GET 'https://graph.facebook.com/v21.0/<WHATSAPP_BUSINESS_ACCOUNT_ID>' \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
Phản hồi mẫu
{
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
"name": "Your WhatsApp Business Account Name",
"timezone_id": "1",
"message_template_namespace": "05155c78_261e_4b2f_82b3_d7958d4cf75f"
}
Để lấy thông tin cụ thể về một doanh nghiệp (chẳng hạn như tên, mẫu tin nhắn và số điện thoại), hãy gửi yêu cầu GET đến điểm cuối WhatsAppBusinessAccount, trong đó <WHATSAPP_BUSINESS_ACCOUNT_ID> là ID tài khoản WhatsApp Business của bạn và đặt thông số fields là danh sách các mục mà bạn muốn nhận được.
Yêu cầu mẫu
curl -i -X GET 'https://graph.facebook.com/v21.0/<WHATSAPP_BUSINESS_ACCOUNT_ID>?fields=id,name,message_templates,phone_numbers' \
-H 'Authorization: Bearer <ACCESS_TOKEN>'
Phản hồi mẫu
{
"id": "<WHATSAPP_BUSINESS_ACCOUNT_ID>",
"name": "Your WhatsApp Business Account Name",
"message_templates": {
"data": [
{
"name": "hello_world",
"components": [
{
"type": "HEADER",
"format": "TEXT",
"text": "Hello World"
},
{
"type": "BODY",
"text": "Welcome and congratulations!! This message demonstrates your ability to send a message notification from WhatsApp Business Platform. Thank you for taking the time to test with us."
},
{
"type": "FOOTER",
"text": "WhatsApp Business Team"
}
],
"language": "en_US",
"status": "APPROVED",
"category": "ACCOUNT_UPDATE",
"id": "307191531401674"
},
{
"name": "sample_flight_confirmation",
"components": [
{
"type": "HEADER",
"format": "DOCUMENT"
},
{
"type": "BODY",
"text": "Confirmamos tu vuelo a {{1}}-{{2}} para el {{3}}."
},
{
"type": "FOOTER",
"text": "Este mensaje proviene de un negocio no verificado."
}
],
"language": "es",
"status": "APPROVED",
"category": "TICKET_UPDATE",
},
...
Giới hạn tốc độ
| Loại lệnh gọi | Điểm cuối |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
| Loại lệnh gọi | Điểm cuối |
|---|---|
|
|
|
|
|
|
|
|
Hãy xem phần Tiêu đề để biết thêm thông tin về cách nhận mức sử dụng tốc độ hiện tại của bạn.
Tìm hiểu thêm
- Facebook SDK - Bạn có thể triển khai một trong các SDK của chúng tôi để yêu cầu người dùng cấp quyền qua phương thức Đăng nhập bằng Facebook.
- Trình quản lý kinh doanh API Marketing - Tìm hiểu thêm về Trình quản lý kinh doanh API Marketing.
- Xét duyệt ứng dụng - Tìm hiểu thêm về quy trình truy cập dữ liệu của riêng bạn hoặc dữ liệu thuộc sở hữu của người khác.
- Xem video Thiết lập Nền tảng WhatsApp Business.
Bước tiếp theo
- Hướng dẫn - Tìm hiểu những việc khác bạn có thể làm với API Quản lý WhatsApp Business.
