Để tiếp tục, hãy đảm bảo bạn đã hoàn tất các bước trong phần Điều kiện tiên quyết và chúng tôi đã phê duyệt quyền truy cập vào API Trang doanh nghiệp cho dự án của bạn.
Bật các API
Có 8 API liên kết với Trang doanh nghiệp mà bạn phải bật trong Google API Console:
- API Google Doanh nghiệp của tôi
- API Quản lý tài khoản doanh nghiệp của tôi
- API Phòng cho thuê của Doanh nghiệp của tôi
- API My Business Place Actions
- API Thông báo về doanh nghiệp của tôi
- API Xác minh doanh nghiệp của tôi
- API Thông tin doanh nghiệp của tôi
- API Hỏi và đáp Doanh nghiệp của tôi
Bật API
Nếu đã hoàn thành tất cả Điều kiện tiên quyết và đã được cấp quyền truy cập vào API nhưng vẫn không thể sử dụng phím tắt được cung cấp, thì bạn có thể bật API theo cách thủ công bằng các bước sau.
Để bật API cho dự án, hãy làm như sau:
- Mở Thư viện API trong Google API Console. Nếu được nhắc, hãy chọn một dự án hoặc tạo một dự án mới. Thư viện API liệt kê tất cả API hiện có, được nhóm theo nhóm sản phẩm và mức độ phổ biến.
- Nếu API bạn muốn chọn không hiển thị trong danh sách, hãy sử dụng chức năng tìm kiếm để tìm API đó.
- Chọn API bạn muốn bật, sau đó nhấp vào nút Enable (Bật).
- Nếu bạn nhận được một lời nhắc, hãy bật tính năng thanh toán.
- Nếu được nhắc, hãy chấp nhận Điều khoản dịch vụ của API.
Nếu bạn là người dùng Google Workspace, hãy xác nhận rằng Trang doanh nghiệp trên Google đã được bật cho tài khoản của bạn trong tổ chức trên Google Workspace. Nếu Trang doanh nghiệp trên Google bị tắt đối với tài khoản của bạn trong tổ chức trên Google Workspace, bạn sẽ gặp "lỗi 403 – QUYỀN BỊ TỪ CHỐI" khi sử dụng API GBP.
Yêu cầu mã ứng dụng khách OAuth 2.0
Vì ứng dụng của bạn truy cập vào dữ liệu được bảo vệ, không công khai, nên bạn cần có mã ứng dụng khách OAuth 2.0. Việc này cho phép ứng dụng yêu cầu cấp quyền truy cập vào dữ liệu vị trí của tổ chức thay mặt cho người dùng ứng dụng.
Ứng dụng của bạn phải gửi một mã thông báo OAuth 2.0 cùng với bất kỳ yêu cầu API Trang doanh nghiệp nào truy cập vào dữ liệu riêng tư của người dùng.
Nếu bạn chưa thực hiện việc này, hãy chuyển đến phần "Thông tin xác thực" trong Bảng điều khiển API của Google rồi nhấp vào Tạo thông tin xác thực > Mã ứng dụng khách OAuth để tạo thông tin xác thực OAuth 2.0. Sau khi tạo thông tin xác thực, bạn có thể thấy mã ứng dụng khách của mình trên trang Thông tin xác thực. Nhấp vào mã ứng dụng khách để biết thông tin chi tiết, chẳng hạn như mật khẩu ứng dụng khách, URI chuyển hướng, địa chỉ nguồn gốc JavaScript và địa chỉ email.
Tìm hiểu kiến thức cơ bản về REST
Có hai cách để gọi các API:
- Gửi yêu cầu HTTP và phân tích cú pháp phản hồi.
- Dùng thư viện ứng dụng.
Nếu quyết định không sử dụng thư viện ứng dụng, bạn cần nắm được kiến thức cơ bản về REST.
REST là một kiểu cấu trúc phần mềm mang lại một phương thức tiếp cận thuận tiện và nhất quán để yêu cầu và sửa đổi dữ liệu.
Thuật ngữ REST là viết tắt của "Đại diện chuyển trạng thái". Trong ngữ cảnh của các API của Google, nó đề cập đến việc sử dụng các động từ HTTP để truy xuất và sửa đổi cách trình bày dữ liệu do Google lưu trữ.
Hệ thống RESTful lưu trữ tài nguyên trong một kho dữ liệu. Ứng dụng gửi yêu cầu để máy chủ thực hiện một thao tác cụ thể, chẳng hạn như tạo, truy xuất, cập nhật hoặc xoá tài nguyên, sau đó máy chủ sẽ thực hiện thao tác đó và gửi phản hồi. Phản hồi đó thường ở dạng đại diện của tài nguyên đã chỉ định.
Trong các API RESTful của Google, ứng dụng chỉ định một hành động có động từ HTTP, chẳng hạn như GET, POST, PUT hoặc DELETE. Ứng dụng chỉ định một tài nguyên bằng một giá trị nhận dạng tài nguyên đồng nhất (URI) duy nhất trên toàn hệ thống có dạng sau:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Vì mọi tài nguyên API đều có URI riêng biệt có thể truy cập HTTP, nên REST cho phép lưu dữ liệu vào bộ nhớ đệm và được tối ưu hoá để hoạt động với cơ sở hạ tầng phân phối của web.
Bạn có thể thấy định nghĩa về phương thức trong tài liệu về tiêu chuẩn HTTP 1.1 hữu ích. Các bản cập nhật này bao gồm thông số kỹ thuật cho GET, POST, PUT và DELETE.
REST trong API Trang doanh nghiệp
Các hoạt động của API Trang doanh nghiệp liên kết trực tiếp đến các động từ HTTP REST.
Định dạng cụ thể của API Trang doanh nghiệp sẽ xuất hiện trong URI sau:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Bạn có thể xem tập hợp đầy đủ các URI dùng cho từng thao tác được hỗ trợ trong các API này trong tài liệu Tài liệu tham khảo về API Trang doanh nghiệp.
Đường dẫn tài nguyên khác nhau tuỳ theo điểm cuối.
Ví dụ: đường dẫn tài nguyên đến một tài khoản xuất hiện như trong ví dụ sau:
accounts/accountId
Đường dẫn tài nguyên cho một vị trí xuất hiện ở dạng sau:
locations/locationId
Tìm hiểu kiến thức cơ bản về JSON
API Trang doanh nghiệp trả về dữ liệu ở định dạng JSON.
Ký hiệu đối tượng JavaScript (JSON) là một định dạng dữ liệu phổ biến, không phụ thuộc vào ngôn ngữ, cung cấp bản trình bày văn bản đơn giản của các cấu trúc dữ liệu tuỳ ý. Để biết thêm thông tin, hãy xem json.org.
Sử dụng OAuth Playground để đưa ra một yêu cầu HTTP đơn giản
Bạn có thể sử dụng OAuth 2.0 Playground để thử nghiệm với các API Trang doanh nghiệp. Vì API Trang doanh nghiệp không phải là API công khai, nên bạn cần thực hiện thêm một số bước để sử dụng API này trong Playground. Bạn cần có một mã ứng dụng khách cho một ứng dụng web để tiếp tục.
- Chuyển đến Google API Console rồi mở dự án của bạn. Nếu bạn chưa có mã ứng dụng khách OAuth cho các ứng dụng web, hãy tạo một mã ngay:
- Trong danh sách thả xuống Tạo thông tin xác thực, hãy chọn Mã ứng dụng khách OAuth.
- Đối với Application type (Loại ứng dụng), hãy nhấp vào Web Application (Ứng dụng web).
Hãy thêm mã sau dưới dạng một URI chuyển hướng hợp lệ:
https://developers.google.com/oauthplayground
- Nhấp vào Tạo.
- Sao chép mã ứng dụng khách vào bảng nhớ tạm.
- Chuyển đến OAuth 2.0 Playground.
- Nhấp vào biểu tượng bánh răng để mở các tùy chọn cấu hình và thực hiện các thay đổi sau:
- Đặt quy trình OAuth thành Phía ứng dụng.
- Chọn Use your own OAuth credentials (Sử dụng thông tin đăng nhập OAuth của riêng bạn).
- Dán mã ứng dụng khách OAuth.
- Đóng các lựa chọn cấu hình.
Trong "Bước 1 – Chọn và uỷ quyền API", hãy dán phạm vi sau đây của API Trang doanh nghiệp vào trường Nhập phạm vi của riêng bạn:
https://www.googleapis.com/auth/business.manage
- Nhấp vào Uỷ quyền API.
- Nhấp vào Chấp nhận khi được nhắc.
-
Trong "Bước 2 - Định cấu hình yêu cầu tới API", hãy dán URI sau vào trường URI yêu cầu:
https://mybusinessaccountmanagement.googleapis.com/v1/accounts
- Nhấp vào Gửi yêu cầu. Phản hồi phải hiển thị trạng thái
200 OK.
Để biết thêm thông tin về cách tạo nhiều loại yêu cầu, hãy xem Tài liệu tham khảo về API Trang doanh nghiệp.
Thư viện ứng dụng
Thư viện ứng dụng API Trang doanh nghiệp hỗ trợ chức năng của API Trang doanh nghiệp. Các API này cung cấp chức năng chung cho tất cả API của Google, chẳng hạn như truyền tải HTTP, xử lý lỗi, xác thực và phân tích cú pháp JSON.
Để tải thư viện ứng dụng xuống, hãy xem phần Thư viện.