Nhảy tới nội dung

Bắt đầu

Để vận hành qua BP OpenAPI, Doanh nghiệp cần đăng ký và xác thực Business Page (BP).

Trường hợp Doanh nghiệp chưa có BP, hãy bắt đầu bằng việc đăng ký và hoàn tất xác thực thông tin doanh nghiệp của mình hoặc được uỷ quyền quản lý.

👉 Liên hệ để sở hữu ngay Trang Doanh nghiệp miễn phí trên MoMo:

MoMo luôn từng ngày cải thiện để mang lại trải nghiệm tích hợp vận hành MoMo BP dễ dàng và an toàn nhất.

Trình tự để bắt đầu tích hợp BP OpenAPI

Vận hành MoMo BP bằng BP OpenAPI​

Doanh nghiệp cần tích hợp MoMo BP OpenAPI với hệ thống (server) của Doanh nghiệp thông qua tài khoản tích hợp được MoMo cung cấp.

MoMo cung cấp bộ Mã tương ứng với từng môi trường (gọi chung là bộ MoMo API-KEY ).

  • Partner Id: Định danh duy nhất của Tài khoản đối tác của Doanh nghiệp
  • Client ID & Client Secret: Dùng để Xác thực với MoMo

Doanh nghiệp cần lưu trữ bộ MoMo API-KEY này để khởi tạo access_token và đính kèm access_token này vào tất cả các request khi gọi sang BP OpenAPI tương ứng với nhóm quyền được gán quản lý và khai thác thông tin BP.

Các nhóm quyền của hệ thống BP OpenAPI tương ứng với nhóm quyền được cấp cho Doanh nghiệp vào cổng thông tin Đối tác kinh doanh quản lý BP gồm: Quản lý & Thiết lập Trang, Đăng Bài viết, Gửi tin nhắn thông báo, Xem báo cáo, Chăm sóc khách hàng... Mỗi nhóm quyền sẽ được quy định các thao tác, tính năng trên BP.

Ngoài ra, MoMo hỗ trợ Doanh nghiệp đăng ký URL để ghi nhận các sự kiện khi có phát sinh tương tác giữa người dùng và BP trên MoMo, hoặc có các thông báo cập nhật từ Đội vận hành MoMo BP (tham khảo thêm Cách thức đăng ký nhận sự kiện từ MoMo).

Các nhóm quyền BP​

QuyềnAPI hỗ trợ
Quyền quản lý và thiết lập BP1. Lấy danh sách Trang đang quản lý
2. Xem thông tin trang
3. Thiết lập trang
Quyền quản lý nội dung1. Nội dung dạng Bài viết
2. Nội dung Xếp hạng (Rating) và Đánh giá Trang (Review)
Quyền gửi tin nhắn1. Đăng ký Template
2. Gửi tin nhắn CSKH đến tập khách hàng (Segmentation)
3. Gửi tin nhắn tự động theo điều kiện
4. Khởi tạo Tập khách hàng

Quy ước API​

HTTP Request:

URL Development: https://test-business.momo.vn/api
URL Production: https://business.momo.vn/api
Content Type: application/json
Response Type: application/json


Xác thực và uỷ quyền truy cập tài nguyên BP​

HTTP Request

POST /authentication/login


Example request

curl --location 'https://test-business.momo.vn/api/authentication/login' \
--header 'Content-Type: application/json' \
--data '{
"clientId": "{{clientId}}",
"clientSecret": "{{clientSecret}}"
}'


Request Body

Tham sốKiểuBắt buộcMô tả
clientIdStringID được cấp theo từng Trang Doanh nghiệp
clientSecretStringPassword của tài khoản được cấp theo từng Trang Doanh nghiệp

Example response

{
    "status": 0,
    "message": "Success",
    "data": {
        "accessToken": "eyJhbGciOiJIUzUxMiJ9.eyJ0eXBlIjoibWVyY2hhbnQiLCJleHAiOjE3MDA1NTA3MDMsImlhdCI6MTcwMDQ2NDMwMywidXNlcm5hbWUiOiJpcG9zbWFzdGVybWVyY2hhbnQifQ.hF8u_lEpWJwI5T-JihAN85sYGPWng_1KoB1CkKMrG1kmgmd-UwLxudvnzlCpkHw9jmnOg6mLxT3lBVQ6yt3qJw",
        "expiresIn": 86400000
    }
}

Cấu trúc response

Tham sốKiểuBắt buộcMô tả
statusNumberMã status code trả về
messageStringMô tả trả về diễn giải cho status code
dataObject JsonDữ liệu MoMo trả về

Thuộc tính data trong Response

Tham sốKiểuMô tả
accessTokenStringAccess Token dùng để gọi BP OpenAPI
expiresInNumberThời gian hiệu lực được tính bằng milliseconds. Mặc định 86400000 (24 tiếng)

ON THIS PAGE