Định cấu hình đăng ký ứng dụng

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về Apigee X. thông tin

Nhà phát triển sử dụng trang Ứng dụng của tôi trên cổng Dịch vụ dành cho nhà phát triển để đăng ký ứng dụng. Nhà phát triển truy cập vào trang Ứng dụng của tôi từ trình đơn chính của cổng thông tin:

Để đăng ký ứng dụng mới, nhà phát triển chọn nút Thêm ứng dụng mới trên trang Ứng dụng của tôi.

Sau đó, cổng thông tin sẽ hiển thị biểu mẫu đăng ký ứng dụng mặc định:

Theo mặc định, nhà phát triển chỉ phải chỉ định tên ứng dụng, URL gọi lại và danh sách sản phẩm API cần thêm vào ứng dụng.

Là nhà cung cấp API, bạn có toàn quyền kiểm soát quy trình đăng ký ứng dụng. Ví dụ: bạn có thể định cấu hình:

  • Danh sách các sản phẩm API có trên cổng thông tin
  • Có sản phẩm API mặc định hay không
  • Liệu URL gọi lại có bắt buộc hay không
  • Cho biết khoá API được phê duyệt theo cách thủ công hay tự động cho một sản phẩm API
  • Có cần thông tin nào khác trên trang Thêm ứng dụng để đăng ký ứng dụng không

Chủ đề này mô tả cách định cấu hình quá trình đăng ký ứng dụng cho cổng thông tin của bạn. Tuy nhiên, chủ đề này không mô tả cách tạo các sản phẩm API. Để biết thêm thông tin, hãy xem bài viết:

Bạn có thể định cấu hình cổng thông tin để cấm nhà phát triển tạo, xoá hoặc chỉnh sửa ứng dụng dựa trên vai trò được chỉ định cho nhà phát triển. Ví dụ: bạn có thể định cấu hình cổng thông tin để tạo một ứng dụng mặc định duy nhất cho tất cả nhà phát triển khi nhà phát triển đăng ký. Sau đó, bạn chỉ cho phép một số nhà phát triển thêm ứng dụng mới, có thể dựa trên cơ cấu phí hoặc các đặc điểm khác của nhà phát triển. Dùng các vai trò và quyền để kiểm soát những nhà phát triển có thể tạo, xoá và chỉnh sửa ứng dụng. Hãy xem bài viết Thêm và quản lý tài khoản người dùng để biết thêm thông tin.

Chỉ định các sản phẩm API có sẵn trên cổng thông tin

Có 2 cách để chỉ định các sản phẩm API sẽ có sẵn khi nhà phát triển truy cập vào cổng thông tin:

Chỉ định cấp truy cập khi tạo sản phẩm API

Khi tạo một sản phẩm API, bạn sẽ chỉ định tuỳ chọn cấp truy cập của sản phẩm đó, như sau:

Để biết thêm thông tin về mức độ ảnh hưởng của cấp truy cập đến khả năng cung cấp sản phẩm API trong cổng thông tin dành cho nhà phát triển Drupal 7, hãy xem bài viết Cấp truy cập.

Hạn chế quyền truy cập vào một sản phẩm API dựa trên vai trò

Khi bật mô-đun Drupal có quyền truy cập vào vai trò trong sản phẩm API, bạn có thể chỉ định các vai trò có thể truy cập vào từng sản phẩm API.

Cách hạn chế quyền truy cập vào một sản phẩm API dựa trên vai trò của nhà phát triển:

  1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Xem lại các vai trò của cổng thông tin nhà phát triển và thông tin chỉ định người dùng:
    • Chọn Mọi người > Quyền > Vai trò trong trình đơn quản trị Drupal rồi thêm hoặc chỉnh sửa vai trò và quyền của nhà phát triển theo yêu cầu.
    • Chọn Mọi người trong trình đơn quản trị Drupal rồi chỉnh sửa thông tin chỉ định người dùng và vai trò theo yêu cầu.
  3. Chọn Cấu hình > Cổng nhà phát triển > Quyền truy cập vai trò trong sản phẩm API trong trình đơn quản trị Drupal.
  4. Chọn vai trò mà bạn muốn có quyền truy cập vào từng sản phẩm API.
  5. Nhấp vào Lưu cấu hình.

Định cấu hình cách nhà phát triển liên kết các sản phẩm API với ứng dụng

Để đăng ký ứng dụng mới, nhà phát triển sẽ chọn nút Thêm ứng dụng mới trên trang Ứng dụng của tôi để mở biểu mẫu Thêm ứng dụng:

Dựa trên cách bạn định cấu hình cổng thông tin, nhà phát triển có thể chọn một hoặc nhiều sản phẩm API để liên kết với ứng dụng tại thời điểm đăng ký ứng dụng. Hoặc bạn có thể chỉ định một sản phẩm mặc định được chỉ định cho mọi ứng dụng.

Các tuỳ chọn cấu hình sau có sẵn trên cổng thông tin để kiểm soát việc lựa chọn sản phẩm API khi đăng ký ứng dụng:

  • Đừng liên kết ứng dụng với bất kỳ sản phẩm API nào.
  • Liên kết tất cả ứng dụng với một hoặc nhiều Sản phẩm API mặc định (được định cấu hình bên dưới). Nhà phát triển không thể thêm bất kỳ sản phẩm API nào khác vào ứng dụng.
  • Cho phép lựa chọn một sản phẩm API duy nhất, nhưng không yêu cầu sản phẩm đó.
  • Yêu cầu chọn một sản phẩm API duy nhất.
  • Cho phép lựa chọn nhiều Sản phẩm API, nhưng không yêu cầu bất kỳ sản phẩm nào.
  • Cho phép lựa chọn nhiều Sản phẩm API và yêu cầu ít nhất một sản phẩm.

Bạn cũng có thể kiểm soát phần tử HTML xuất hiện trên biểu mẫu mà nhà phát triển sử dụng để chọn sản phẩm API. Các lựa chọn bao gồm:

  • Danh sách thả xuống.
  • Hộp đánh dấu hoặc nút chọn. Hộp đánh dấu xuất hiện khi nhà phát triển có thể chọn nhiều sản phẩm API và nút chọn xuất hiện khi nhà phát triển chỉ có thể chọn một sản phẩm API.

Cách đặt chế độ chọn sản phẩm API:

  1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Chọn Cấu hình > Cài đặt cổng thông tin cho nhà phát triển > Cài đặt ứng dụng trong trình đơn quản trị Drupal.
  3. Trên trang Cài đặt ứng dụng, hãy mở rộng phần Cài đặt sản phẩm API.
  4. Trong mục Xử lý sản phẩm API, hãy chọn mục kiểm soát việc lựa chọn sản phẩm API.
  5. Nếu bạn chỉ định lựa chọn "Liên kết tất cả ứng dụng với một hoặc nhiều Sản phẩm API mặc định (được định cấu hình bên dưới)", hãy đặt sản phẩm mặc định trong phần Sản phẩm API mặc định.
  6. Trong API Product Widget (Tiện ích sản phẩm API), hãy chọn phần tử HTML mà nhà phát triển sử dụng để chọn các sản phẩm API.
  7. Lưu cấu hình.

Định cấu hình xử lý URL gọi lại

Nếu một proxy API trong sản phẩm API của bạn sử dụng " OAuth ba chân" (loại cấp mã uỷ quyền), thì nhà phát triển cần chỉ định URL gọi lại khi đăng ký ứng dụng của họ. URL gọi lại thường chỉ định URL của một ứng dụng được chỉ định để nhận mã uỷ quyền thay mặt cho ứng dụng khách. Ngoài ra, chuỗi URL này được dùng để xác thực. Khách hàng phải gửi URL này cho Apigee Edge khi yêu cầu mã uỷ quyền và mã truy cập, đồng thời tham số redirect_uri phải khớp với tham số đã đăng ký. Để biết thêm thông tin, hãy xem phần Triển khai loại cấp mã uỷ quyền.

Cách kiểm soát URL gọi lại cho lựa chọn sản phẩm API:

  1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Chọn Cấu hình > Cài đặt cổng thông tin cho nhà phát triển > Thuộc tính ứng dụng trong trình đơn quản trị Drupal.
  3. Trên trang Cài đặt ứng dụng, hãy mở rộng phần Cài đặt URL gọi lại.
  4. Trong phần Xử lý URL gọi lại, hãy chọn một trong các lựa chọn sau.
    • Tất cả ứng dụng của nhà phát triển đều phải có URL gọi lại.
    • URL gọi lại là không bắt buộc đối với tất cả ứng dụng của nhà phát triển.
    • URL gọi lại không bắt buộc cũng không hiển thị.
  5. Lưu cấu hình.

Hiển thị số liệu phân tích về mức sử dụng ứng dụng

Cổng thông tin này có thể hiển thị thông tin phân tích về mức sử dụng ứng dụng. Nếu chế độ hiển thị số liệu phân tích được bật, nhà phát triển ứng dụng có thể xem số liệu phân tích trên trang Ứng dụng của tôi cho từng ứng dụng. Ví dụ: nhà phát triển có thể hiển thị số liệu phân tích sau đây cho một ứng dụng:

  • Thông lượng
  • Thời gian phản hồi tối đa
  • Thời gian phản hồi tối thiểu
  • Số lượng tin nhắn
  • Số lỗi

Cách bật số liệu phân tích trên cổng thông tin:

  1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Chọn Cấu hình > Cổng nhà phát triển > Cài đặt ứng dụng trong trình đơn quản trị Drupal.
  3. Trên trang Cài đặt ứng dụng, hãy mở rộng phần Cài đặt hiệu suất của ứng dụng.
  4. Chọn hộp kiểm Hiển thị thẻ Phân tích ứng dụng dành cho nhà phát triển.
  5. Chọn Kiểm thử hoặc Sản xuất cho Môi trường để truy vấn dữ liệu phân tích. Đối với một cổng thông tin được cung cấp công khai, thông thường, bạn sẽ chọn Phát hành công khai.
  6. Lưu cấu hình.

Cách hiển thị số liệu phân tích trên cổng thông tin cho một ứng dụng:

  1. Chọn tên ứng dụng trên trang Ứng dụng của tôi.
  2. Chọn đường liên kết đến Analytics cho ứng dụng.
  3. Chọn loại số liệu phân tích mà bạn muốn hiển thị và phạm vi ngày:
  4. Thông tin bạn chọn sẽ xuất hiện:

Phê duyệt hoặc thu hồi khoá API theo cách thủ công cho một sản phẩm API

Khi nhà phát triển thêm một sản phẩm API vào một ứng dụng rồi đăng ký ứng dụng, cổng thông tin sẽ trả về cho nhà phát triển khoá API của ứng dụng đó. Sau đó, nhà phát triển sử dụng khoá API đó để truy cập vào các proxy API đi kèm với sản phẩm API liên kết với ứng dụng.

Bạn kiểm soát quy trình phê duyệt khoá cho từng sản phẩm API khi tạo sản phẩm API:

Quy trình phê duyệt có thể là:

  • Automatic (Tự động) – Cổng thông tin cho sản phẩm API sẽ trả về khoá API đã phê duyệt khi nhà phát triển đăng ký ứng dụng. Sau đó, bạn có thể thu hồi khoá được phê duyệt tự động.
  • Thủ công – Cổng API sẽ trả về khi nhà phát triển đăng ký ứng dụng, nhưng khoá này không được kích hoạt cho bất kỳ sản phẩm API nào sử dụng phê duyệt khoá theo cách thủ công. Quản trị viên phải phê duyệt khoá API theo cách thủ công trong giao diện người dùng hoặc API quản lý Edge, thì nhà phát triển mới có thể dùng khoá đó để truy cập vào sản phẩm API. Sau đó, bạn có thể thu hồi khoá đã được phê duyệt theo cách thủ công.

Hãy xem bài viết Tạo sản phẩm API để biết thêm thông tin.

Nếu cổng thông tin của bạn cho phép nhà phát triển thêm nhiều sản phẩm API vào một ứng dụng, thì nhà phát triển có thể thêm một số sản phẩm có chế độ Phê duyệt khoá tự động và một số sản phẩm có chế độ Tự động phê duyệt. Nhà phát triển có thể sử dụng ngay khoá API được trả về cho tất cả sản phẩm API được phê duyệt tự động trong khi chờ phê duyệt cuối cùng đối với những sản phẩm yêu cầu phê duyệt theo cách thủ công.

Để xem danh sách sản phẩm API cho một ứng dụng và trạng thái phê duyệt khoá cho sản phẩm API, nhà phát triển sẽ chọn tên của ứng dụng đó trên trang Ứng dụng của tôi rồi chọn đường liên kết Sản phẩm:

Trong ví dụ này, sản phẩm Premium Weather API sử dụng tính năng Phê duyệt thủ công và đang chờ quản trị viên phê duyệt khoá. Sản phẩm API miễn phí sử dụng tính năng Phê duyệt tự động và hoạt động sử dụng khoá để truy cập vào sản phẩm này đã được phê duyệt.

Cách phê duyệt hoặc thu hồi khoá theo cách thủ công:

  1. Đăng nhập vào Giao diện người dùng quản lý cạnh với tư cách là người dùng có đặc quyền quản trị cho tổ chức của bạn.
  2. Chọn Nền tảng API trong hộp thả xuống ở góc trên bên phải.
  3. Chọn Phát hành > Ứng dụng của nhà phát triển để mở danh sách ứng dụng của nhà phát triển.
  4. Chọn nút Pending (Đang chờ xử lý) để xem danh sách ứng dụng có yêu cầu khoá đang chờ xử lý:

  5. Chọn tên ứng dụng mà bạn muốn phê duyệt.
  6. Trên trang chi tiết của ứng dụng, hãy chọn nút Edit (Chỉnh sửa) ở góc trên bên phải.
  7. Trong danh sách sản phẩm API cho ứng dụng, ở phần Hành động:
    • Để phê duyệt khoá, hãy chọn nút Phê duyệt cho từng sản phẩm API yêu cầu phê duyệt thủ công.

    • Để thu hồi khoá đã phê duyệt, hãy chọn nút Thu hồi trong mục Hành động dành cho sản phẩm API để thu hồi quyền truy cập.

  8. Lưu ứng dụng. Khoá API hiện đã được phê duyệt.

Kiểm soát việc lưu sản phẩm API và ứng dụng vào bộ nhớ đệm

Thông tin về các sản phẩm API và ứng dụng của nhà phát triển được lưu trữ từ xa từ cổng thông tin trên Apigee Edge. Tức là bạn có thể thực hiện các thay đổi đối với sản phẩm và ứng dụng API từ giao diện người dùng hoặc API Edge mà không cần thông qua cổng thông tin. Ví dụ: khi quản trị viên phụ trợ thêm một sản phẩm API mới, cổng thông tin sẽ không được cập nhật ngay thông tin đó.

Để đảm bảo cổng thông tin luôn đồng bộ với phần phụ trợ Edge, bạn có thể kích hoạt bản cập nhật bộ nhớ đệm của cổng theo cách thủ công, tự động cập nhật bộ nhớ đệm khi lệnh định kỳ của cổng thông tin chạy hoặc cả hai. Ví dụ: nếu định cấu hình công việc chạy theo thời gian (cron job) để chạy thường xuyên, chẳng hạn như 5 hoặc 10 phút một lần, bạn có thể không muốn tốn phí cập nhật các sản phẩm API và bộ nhớ đệm của ứng dụng dành cho nhà phát triển thường xuyên. Trong trường hợp này, bạn có thể kích hoạt quá trình cập nhật bộ nhớ đệm theo cách thủ công. Tuy nhiên, nếu công việc cron này chạy mỗi giờ hoặc hai giờ một lần, thì thời gian cần thiết để cập nhật bộ nhớ đệm có thể không ảnh hưởng nhiều.

Theo mặc định, cổng thông tin được định cấu hình để tạo lại bộ nhớ đệm của sản phẩm API và ứng dụng dành cho nhà phát triển mỗi khi cron chạy.

Cách chỉ định xem có cần tạo lại sản phẩm API và bộ nhớ đệm của ứng dụng dành cho nhà phát triển mỗi khi cron chạy không:

  1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Trên trình đơn Drupal, hãy chọn Cấu hình > Cài đặt cổng thông tin cho nhà phát triển > Cài đặt ứng dụng.
  3. Đánh dấu hoặc bỏ đánh dấu Rebuild API Product and Developer App caches (Tạo lại bộ nhớ đệm của sản phẩm API và ứng dụng dành cho nhà phát triển mỗi khi cron chạy).
  4. Lưu cài đặt của bạn.

Cách cập nhật bộ nhớ đệm theo cách thủ công:

  1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Trong trình đơn Drupal, hãy chọn Home icon > Flush all caches (Biểu tượng trang chủ > Xoá tất cả bộ nhớ đệm).

Tuỳ chỉnh các trường trên biểu mẫu dùng để đăng ký ứng dụng

Khi nhà phát triển đăng ký ứng dụng, cổng thông tin sẽ hiển thị biểu mẫu mặc định:

Là nhà cung cấp API, bạn nên sửa đổi biểu mẫu này để nhắc nhà phát triển cung cấp thêm những thông tin như mã khách hàng, nền tảng mục tiêu của ứng dụng hoặc thông tin khác. Cổng thông tin cho phép bạn thêm trường mới vào biểu mẫu này. Các trường này có thể là:

  • Bắt buộc hoặc không bắt buộc
  • Được hiển thị bằng các phần tử HTML khác nhau, chẳng hạn như hộp văn bản, nút chọn, hộp kiểm, v.v.
  • Có thể được đặt để xuất hiện ở bất kỳ nơi nào trên biểu mẫu giữa trường URL gọi lại và trường Sản phẩm

Để tìm hiểu cách tuỳ chỉnh biểu mẫu đăng ký ứng dụng có trên cổng thông tin dành cho nhà phát triển, hãy xem video này.

Ví dụ: biểu mẫu sau đây hiển thị một trường bắt buộc đối với Mã khách hàng và một trường không bắt buộc đối với nền tảng mục tiêu:

Khi bạn thêm trường mới vào biểu mẫu, các giá trị của trường sẽ tự động được tải lên Edge cùng với tất cả các trường khác khi nhà phát triển gửi biểu mẫu. Điều đó có nghĩa là bạn có thể xem hoặc sửa đổi những trường đó trên Edge, hoặc sử dụng Edge Management API (API Quản lý Edge) để truy cập vào các trường đó qua một tập lệnh.

Ví dụ: hãy xem các trường biểu mẫu mới trong giao diện người dùng quản lý Edge bằng cách chuyển đến phần Phát hành > Ứng dụng dành cho nhà phát triển, sau đó chọn tên ứng dụng. Các giá trị mới của trường sẽ xuất hiện trong phần Thuộc tính tuỳ chỉnh của trang cùng với tên tương ứng với tên nội bộ của trường:

Các giá trị của trường cũng hiển thị trong vùng Chi tiết của ứng dụng trên trang Ứng dụng của tôi của nhà phát triển:

Nhà phát triển cũng có thể chỉnh sửa các giá trị bằng cách chọn đường liên kết Chỉnh sửa cho ứng dụng trên trang Ứng dụng của tôi.

Quy trình dưới đây mô tả cách định cấu hình biểu mẫu tạo ứng dụng bằng cách sử dụng giao diện quản trị viên. Nhà phát triển Drupal có thể sử dụng hook tuỳ chỉnh để tuỳ chỉnh thêm, bao gồm cả việc sửa đổi trang "Ứng dụng của tôi". Để tìm hiểu thêm về cách thay đổi hành vi thông qua mã, hãy xem các ví dụ về API ứng dụng trong tệp: /profiles/apigee/modules/custom/devconnect/devconnect_developer_apps/devconnect_developer_apps.api.php.

Cách thêm trường vào biểu mẫu đăng ký ứng dụng:

  1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Đảm bảo bạn đã bật mô-đun DevConnect App Attributes (Quản lý thuộc tính ứng dụng DevConnect).
  3. Chọn Cấu hình > Cài đặt cổng cho nhà phát triển > Thuộc tính ứng dụng trên cổng thông tin cho nhà phát triển trong trình đơn quản trị Drupal.
  4. Chọn nút Thêm thuộc tính ứng dụng trên cổng thông tin cho nhà phát triển ở đầu trang.
  5. Định cấu hình trường. Ví dụ: đối với trường Mã khách hàng nêu trên, hãy sử dụng các chế độ cài đặt sau:
    • Tên nội bộ = CUSTOMER_id. Đây là tên của biến dùng để lưu trữ giá trị trường.
    • Tên công khai = Mã khách hàng
    • Nội dung mô tả = Nhập mã khách hàng của bạn.
    • Chọn hộp kiểm cho Yêu cầu thuộc tính này
    • Chọn hộp kiểm cho Hiển thị thuộc tính này.
    • Tiện ích = Hộp văn bản
    • Chọn Lưu để quay lại trang Thuộc tính ứng dụng trên cổng thông tin cho nhà phát triển.
  6. Chọn Lưu các thay đổi.
  7. Chọn Biểu tượng màn hình chính > Xoá tất cả bộ nhớ đệm trên trình đơn của Drupal.
    Bạn có thể phải xoá bộ nhớ đệm của trình duyệt thì trường mới xuất hiện trên biểu mẫu.

Để thêm một trường không bắt buộc để nhà phát triển chỉ định nền tảng cho ứng dụng, hãy đặt các thuộc tính của trường như sau:

  • Tên nội bộ = intent_platforms
  • Tên công khai = Nền tảng
  • Mô tả = Chỉ định một hoặc nhiều nền tảng cho ứng dụng.
  • Bỏ chọn hộp kiểm cho Yêu cầu thuộc tính này
  • Chọn hộp đánh dấu cho mục Hiển thị thuộc tính này.
  • Tiện ích = Danh sách các hộp đánh dấu
  • Chọn Lưu để quay lại trang Thuộc tính ứng dụng trên cổng thông tin cho nhà phát triển.

Cách sắp xếp lại thứ tự của các thuộc tính trên biểu mẫu:

  1. Đăng nhập vào cổng thông tin của bạn với tư cách là người dùng có đặc quyền của quản trị viên hoặc tạo nội dung.
  2. Chọn Cấu hình > Cài đặt cổng cho nhà phát triển > Thuộc tính ứng dụng trên cổng thông tin cho nhà phát triển trong trình đơn quản trị Drupal.
  3. Chọn biểu tượng dấu cộng, + trong cột Tên rồi kéo thuộc tính đến vị trí mà bạn muốn hiển thị thuộc tính đó trong biểu mẫu.
  4. Lưu các thay đổi.