Thiết lập Webhook trên Apple Business Connect
Đối tác bên thứ ba có quyền truy cập API có thể nhận thông báo đẩy bằng Webhook đối với những thay đổi trạng thái liên quan đến các tài nguyên và sự kiện khác nhau. Các loại thông báo nhận được bằng Webhook tương đương với các loại thông báo từ API Thông báo.
Ghi chú: Trước khi có thể sử dụng Webhook, bạn cần có quyền truy cập API vào Apple Business Connect và mỗi môi trường cần được Apple chấp thuận. Xem bài viết Yêu cầu quyền truy cập API.
Tạo Webhook đầu tiên
Nếu bạn chưa đăng nhập vào Apple Business Connect, hãy đăng nhập bằng tài khoản người dùng có vai trò Quản trị viên.
Nếu bạn là Quản trị viên cho nhiều công ty, hãy chọn công ty phù hợp trong danh sách Công ty
.Chọn công ty của bạn trong thanh bên, sau đó chọn API bên dưới tên công ty.
Chọn
bên cạnh mục Thêm Webhook, rồi nhập thông tin sau:Thông tin
Mô tả
Webhook
Có thể chứa chữ cái, số và ký hiệu, ngoại trừ những ký tự sau:
; (Dấu chấm phẩy)
’ (Dấu nháy đơn)
[ (Dấu ngoặc vuông bên trái)
] (Dấu ngoặc vuông bên phải)
< (Dấu nhỏ hơn)
> (Dấu lớn hơn)
Thành viên nhóm
Một thành viên nhóm có vai trò là Quản trị viên hoặc Nhà phát triển để liên hệ trong trường hợp kết nối không thành công
Môi trường
Hạn chế:
Bạn không thể thay đổi môi trường sau khi thiết lập Webhook
Mỗi sự kiện chỉ có thể được sử dụng một lần cho một môi trường
URL phần tải
Cần bắt đầu bằng https://
Sự kiện
Cần có ít nhất một tài nguyên hoặc sự kiện khác được chọn
Ghi chú: Sau khi thêm thông tin Webhook, một thông báo ping sẽ được gửi tới URL để xác minh kết nối.
Chọn Lưu.
Chọn nút Sao chép để sao chép mã bí mật máy khách vào Bảng nhớ tạm.
Chia sẻ mã bí mật máy khách với quản trị viên của Webhook.
Sau khi quản trị viên xác nhận họ đã nhận được mã bí mật máy khách, hãy chọn Xong.
Sửa Webhook
Nếu bạn chưa đăng nhập vào Apple Business Connect, hãy đăng nhập bằng tài khoản người dùng có vai trò Quản trị viên.
Nếu bạn là Quản trị viên cho nhiều công ty, hãy chọn công ty phù hợp trong danh sách Công ty
.Chọn công ty của bạn trong thanh bên, sau đó chọn API bên dưới tên công ty.
Chọn
bên cạnh Quản lý Webhook, sau đó chọn một Webhook trong danh sách.Bạn có thể thay đổi các mục sau:
Tên của Webhook
Trạng thái của Webhook
Tên của thành viên nhóm sẽ được liên hệ trong trường hợp kết nối không thành công
URL phần tải
Nếu cần, hãy chọn Tạo mã bí mật máy khách mới, rồi chọn Tạo.
Chia sẻ mã bí mật máy khách với quản trị viên của Webhook.
Sau khi quản trị viên xác nhận họ đã nhận được mã bí mật máy khách, hãy chọn Xong.
Chọn tất cả tài nguyên và sự kiện mà bạn muốn được thông báo.
Ghi chú: Các tài nguyên được sử dụng trong cùng một môi trường Webhook sẽ không dùng được cho nhiều Webhook.
Chọn Lưu.
Xem hoặc thay đổi trạng thái của Webhook
Nếu bạn chưa đăng nhập vào Apple Business Connect, hãy đăng nhập bằng tài khoản người dùng có vai trò Quản trị viên.
Nếu bạn là Quản trị viên cho nhiều công ty, hãy chọn công ty phù hợp trong danh sách Công ty
.Chọn công ty của bạn trong thanh bên, sau đó chọn API bên dưới tên công ty.
Chọn
bên cạnh Quản lý Webhook, sau đó xem danh sách Webhook.Thay đổi trạng thái của Webhook thành Bật hoặc Tắt.
Khi bạn tắt Webhook, việc gửi thông báo tới Webhook đó sẽ dừng lại.
Xóa Webhook
Nếu bạn chưa đăng nhập vào Apple Business Connect, hãy đăng nhập bằng tài khoản người dùng có vai trò Quản trị viên.
Nếu bạn là Quản trị viên cho nhiều công ty, hãy chọn công ty phù hợp trong danh sách Công ty
.Chọn công ty của bạn trong thanh bên, sau đó chọn API bên dưới tên công ty.
Chọn
bên cạnh Quản lý Webhook, sau đó xem danh sách Webhook.Chọn một Webhook, sau đó cuộn xuống và chọn Xóa Webhook.
Chọn Xóa, rồi chọn Lưu.