Bắt đầu nhanh Node.js

Phần bắt đầu nhanh giải thích cách thiết lập và chạy một ứng dụng gọi API Google Workspace.

Các hướng dẫn nhanh về Google Workspace sử dụng thư viện ứng dụng API để xử lý một số thông tin chi tiết về quy trình xác thực và uỷ quyền. Bạn nên sử dụng thư viện ứng dụng cho các ứng dụng của riêng mình. Phần bắt đầu nhanh này sử dụng phương pháp xác thực đơn giản phù hợp với môi trường thử nghiệm. Đối với môi trường phát hành công khai, bạn nên tìm hiểu về quy trình xác thực và uỷ quyền trước khi chọn thông tin xác thực truy cập phù hợp với ứng dụng của mình.

Tạo một ứng dụng dòng lệnh Node.js để gửi yêu cầu đến Directory API.

Mục tiêu

• Thiết lập môi trường.
• Cài đặt thư viện ứng dụng.
• Thiết lập mẫu.
• Chạy mẫu.

Điều kiện tiên quyết

Để chạy hướng dẫn nhanh này, bạn cần có các điều kiện tiên quyết sau:

• Đã cài đặt Node.js và npm.
• Một dự án trên Google Cloud.

• Một miền Google Workspace đã bật quyền truy cập API.
• Một Tài khoản Google trong miền đó có đặc quyền quản trị.

Thiết lập môi trường

Để hoàn tất hướng dẫn nhanh này, hãy thiết lập môi trường của bạn.

Bật API

Trước khi sử dụng API của Google, bạn cần bật các API đó trong một dự án Google Cloud. Bạn có thể bật một hoặc nhiều API trong một dự án Google Cloud.

• Trong Google Cloud Console, hãy bật Directory API.

  Bật API

Định cấu hình màn hình xin phép bằng OAuth

Nếu bạn đang sử dụng một dự án Google Cloud mới để hoàn tất hướng dẫn nhanh này, hãy định cấu hình màn hình đồng ý OAuth và thêm chính bạn làm người dùng thử nghiệm. Nếu bạn đã hoàn tất bước này cho dự án trên Cloud, hãy chuyển sang phần tiếp theo.

1. Trong Google Cloud Console, hãy chuyển đến Trình đơn > API và dịch vụ > Màn hình đồng ý OAuth.

   Chuyển đến màn hình xin phép bằng OAuth

2. Đối với Loại người dùng, hãy chọn Nội bộ, sau đó nhấp vào Tạo.
3. Hoàn tất biểu mẫu đăng ký ứng dụng, sau đó nhấp vào Lưu và tiếp tục.

4. Hiện tại, bạn có thể bỏ qua bước thêm phạm vi và nhấp vào Lưu và tiếp tục. Trong tương lai, khi tạo một ứng dụng để sử dụng bên ngoài tổ chức Google Workspace, bạn phải thay đổi Loại người dùng thành Bên ngoài, sau đó thêm các phạm vi uỷ quyền mà ứng dụng của bạn yêu cầu.

5. Xem lại thông tin tóm tắt về việc đăng ký ứng dụng. Để chỉnh sửa, hãy nhấp vào Chỉnh sửa. Nếu quá trình đăng ký ứng dụng có vẻ ổn, hãy nhấp vào Quay lại trang tổng quan.

Uỷ quyền thông tin xác thực cho ứng dụng trên máy tính

Để xác thực người dùng cuối và truy cập vào dữ liệu người dùng trong ứng dụng, bạn cần tạo một hoặc nhiều mã ứng dụng khách OAuth 2.0. Mã ứng dụng khách được dùng để xác định một ứng dụng với máy chủ OAuth của Google. Nếu ứng dụng của bạn chạy trên nhiều nền tảng, bạn phải tạo một mã ứng dụng riêng cho mỗi nền tảng.

Thận trọng: Bạn phải chạy hướng dẫn nhanh này trên máy và có quyền truy cập vào trình duyệt. Công cụ này không hoạt động nếu chạy trên một thiết bị đầu cuối từ xa như Cloud Shell hoặc qua SSH.

1. Trong Google Cloud Console, hãy chuyển đến Trình đơn > API và dịch vụ > Thông tin xác thực.

   Chuyển đến phần Thông tin xác thực

2. Nhấp vào Tạo thông tin xác thực > Mã ứng dụng OAuth.
3. Nhấp vào Loại ứng dụng > Ứng dụng dành cho máy tính.
4. Trong trường Name (Tên), hãy nhập tên cho thông tin xác thực. Tên này chỉ xuất hiện trong Google Cloud Console.
5. Nhấp vào Tạo. Màn hình ứng dụng khách OAuth đã tạo sẽ xuất hiện, hiển thị Mã ứng dụng khách và Mã xác thực ứng dụng khách mới.
6. Nhấp vào OK. Thông tin xác thực mới tạo sẽ xuất hiện trong phần Mã ứng dụng khách OAuth 2.0.
7. Lưu tệp JSON đã tải xuống dưới dạng credentials.json và di chuyển tệp đó vào thư mục đang hoạt động.

Cài đặt thư viện ứng dụng

• Cài đặt thư viện bằng npm:

  npm install googleapis@105 @google-cloud/local-auth@2.1.0 --save
  

Thiết lập mẫu

1. Trong thư mục đang hoạt động, hãy tạo một tệp có tên index.js.

2. Trong tệp, hãy dán mã sau:

   adminSDK/directory/index.js

   Xem trên GitHub
   const fs = require('fs').promises;
   const path = require('path');
   const process = require('process');
   const {authenticate} = require('@google-cloud/local-auth');
   const {google} = require('googleapis');
   
   // If modifying these scopes, delete token.json.
   const SCOPES = ['https://www.googleapis.com/auth/admin.directory.user'];
   // The file token.json stores the user's access and refresh tokens, and is
   // created automatically when the authorization flow completes for the first
   // time.
   const TOKEN_PATH = path.join(process.cwd(), 'token.json');
   const CREDENTIALS_PATH = path.join(process.cwd(), 'credentials.json');
   
   /**
    * Reads previously authorized credentials from the save file.
    *
    * @return {Promise<OAuth2Client|null>}
    */
   async function loadSavedCredentialsIfExist() {
     try {
       const content = await fs.readFile(TOKEN_PATH);
       const credentials = JSON.parse(content);
       return google.auth.fromJSON(credentials);
     } catch (err) {
       return null;
     }
   }
   
   /**
    * Serializes credentials to a file compatible with GoogleAuth.fromJSON.
    *
    * @param {OAuth2Client} client
    * @return {Promise<void>}
    */
   async function saveCredentials(client) {
     const content = await fs.readFile(CREDENTIALS_PATH);
     const keys = JSON.parse(content);
     const key = keys.installed || keys.web;
     const payload = JSON.stringify({
       type: 'authorized_user',
       client_id: key.client_id,
       client_secret: key.client_secret,
       refresh_token: client.credentials.refresh_token,
     });
     await fs.writeFile(TOKEN_PATH, payload);
   }
   
   /**
    * Load or request or authorization to call APIs.
    *
    */
   async function authorize() {
     let client = await loadSavedCredentialsIfExist();
     if (client) {
       return client;
     }
     client = await authenticate({
       scopes: SCOPES,
       keyfilePath: CREDENTIALS_PATH,
     });
     if (client.credentials) {
       await saveCredentials(client);
     }
     return client;
   }
   
   /**
    * Lists the first 10 users in the domain.
    *
    * @param {google.auth.OAuth2} auth An authorized OAuth2 client.
    */
   async function listUsers(auth) {
     const service = google.admin({version: 'directory_v1', auth});
     const res = await service.users.list({
       customer: 'my_customer',
       maxResults: 10,
       orderBy: 'email',
     });
   
     const users = res.data.users;
     if (!users || users.length === 0) {
       console.log('No users found.');
       return;
     }
   
     console.log('Users:');
     users.forEach((user) => {
       console.log(`${user.primaryEmail} (${user.name.fullName})`);
     });
   }
   
   authorize().then(listUsers).catch(console.error);

Chạy mẫu

1. Trong thư mục đang hoạt động, hãy chạy mẫu:

   node .
   

2. Lần đầu tiên chạy mẫu, bạn sẽ được nhắc uỷ quyền truy cập:
   1. Nếu bạn chưa đăng nhập vào Tài khoản Google, hãy đăng nhập khi được nhắc. Nếu bạn đã đăng nhập vào nhiều tài khoản, hãy chọn một tài khoản để sử dụng cho việc uỷ quyền.
   2. Nhấp vào Chấp nhận.

   Ứng dụng Nodejs của bạn sẽ chạy và gọi Directory API.

   Thông tin uỷ quyền được lưu trữ trong hệ thống tệp, vì vậy, lần tiếp theo bạn chạy mã mẫu, bạn sẽ không được nhắc uỷ quyền.

Các bước tiếp theo

• Khắc phục sự cố xác thực và uỷ quyền
• Hướng dẫn dành cho nhà phát triển về Directory API
• Tài liệu tham khảo về Directory API
• Mục google-api-nodejs-client của GitHub