Để 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 dự án của bạn để truy cập vào API Trang doanh nghiệp.
Bật API
Có 8 API liên kết với Trang doanh nghiệp mà bạn phải bật trong Bảng điều khiển API của Google:
- API Google Doanh nghiệp của tôi
- My Business Account Management API
- 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
- My Business Business Information API
- API Hỏi đáp của Doanh nghiệp của tôi
Bật API
Nếu đã hoàn tất 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 lối tắt được cung cấp, 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 bạn nhận được lời nhắc, hãy chọn một dự án hoặc tạo dự án mới. Thư viện API liệt kê tất cả những API có sẵn, đượ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 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 bạn nhận được một lời nhắc, vui lòng 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 Google Workspace. Bạn sẽ gặp lỗi "lỗi 403 – PERMISSION DENIED" (lỗi 403 – TỪ CHỐI Quyền) khi sử dụng API GBP nếu Trang doanh nghiệp trên Google bị tắt cho tài khoản của bạn trong tổ chức Google Workspace.
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. Điều này cho phép ứng dụng của bạn thay mặt người dùng ứng dụng yêu cầu uỷ quyền truy cập vào dữ liệu vị trí của tổ chức.
Ứng dụng của bạn phải gửi mã thông báo OAuth 2.0 với mọi yêu cầu API Trang doanh nghiệp 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, hãy chuyển đến mục "Thông tin xác thực" của Google API Console 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 trên trang Thông tin xác thực. Nhấp vào mã ứng dụng để xem thông tin chi tiết, chẳng hạn như khoá ứng dụng, URI chuyển hướng, địa chỉ 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 API:
- Gửi yêu cầu HTTP và phân tích cú pháp các phản hồi.
- Sử 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 hiểu các kiến thức cơ bản về REST.
REST là một kiểu kiến trúc phần mềm mang lại cách tiếp cận thuận tiện và nhất quán trong việc yêu cầu và sửa đổi dữ liệu.
Cụm từ REST là viết tắt của "Chuyển giao trạng thái trình bày". Trong ngữ cảnh của API của Google, cụm từ này đề cập đến việc sử dụng các động từ HTTP để truy xuất và sửa đổi các dạng trình bày của dữ liệu do Google lưu trữ.
Hệ thống RESTful lưu trữ tài nguyên trong kho dữ liệu. Máy khách gửi yêu cầu cho máy chủ thực hiện một hành động 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ủ thực hiện hành động đó và gửi phản hồi. Phản hồi đó thường ở dạng mô tả tài nguyên đã chỉ định.
Trong API RESTful của Google, ứng dụng chỉ định một hành động bằng một độ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 theo giá trị nhận dạng tài nguyên thống nhất (URI) duy nhất trên toàn cầu có dạng như sau:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Vì tất cả các tài nguyên API đều có các URI có thể truy cập HTTP duy nhất, nên REST cho phép việc lưu trữ 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 tán của trang web.
Bạn có thể thấy định nghĩa về phương thức trong tài liệu về các chuẩn HTTP 1.1 hữu ích. Các API 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. trong REST.
Định dạng cụ thể cho API Trang doanh nghiệp được hiển thị trong URI sau:
https://apiName.googleapis.com/apiVersion/resourcePath?parameters
Toàn bộ URI được sử dụng cho từng thao tác được hỗ trợ trong API xuất hiện trong tài liệu Tham khảo về API Trang doanh nghiệp.
Đường dẫn tài nguyên thay đổi tuỳ theo điểm cuối.
Ví dụ: đường dẫn tài nguyên đến một tài khoản sẽ 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
Business Profile API 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, độc lập về ngôn ngữ, cung cấp phầ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 để tạo 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ã ứng dụng khách cho ứ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 ứng dụng web, hãy tạo ngay một mã:
- 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 Loại ứng dụng, hãy nhấp vào Ứng dụng web.
Thêm nội dung sau đây làm 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 vào bảng nhớ tạm.
- Truy cập vào OAuth 2.0 Playground.
- Nhấp vào biểu tượng bánh răng để mở các tuỳ chọn cấu hình và thực hiện những thay đổi sau:
- Đặt Quy trình OAuth thành Phía máy khách.
- Chọn Sử dụng thông tin xác thực OAuth của riêng bạn.
- Dán mã ứng dụng khách OAuth của bạn.
- Đóng các tuỳ chọn cấu hình.
Trong phần "Bước 1 – Chọn và uỷ quyền API", hãy dán phạm vi sau đây cho 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 phần "Bước 2 – Định cấu hình yêu cầu đến API", hãy dán URI sau vào trường Yêu cầu URI:
https://mybusinessaccountmanagement.googleapis.com/v1/accounts
- Nhấp vào Gửi yêu cầu. Phản hồi sẽ hiển thị trạng thái là
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 lớp này cung cấp chức năng phổ biến 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.