Đị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ý một ứ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 đó, trang web 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ỉ cần chỉ định tên ứng dụng, URL gọi lại và danh sách sản phẩm API để 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
  • Liệu 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
  • Khoá API được phê duyệt theo cách thủ công hay tự động cho một sản phẩm API
  • Liệu có cần cung cấp thêm thông tin nào khác trên trang Thêm ứng dụng để đăng ký ứng dụng hay không

Chủ đề này mô tả cách định cấu hình quy 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 sản phẩm API. Để biết thêm thông tin, hãy xem:

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 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ấu trúc phí hoặc các đặc điểm khác của nhà phát triển. Sử dụng vai trò và quyền để kiểm soát nhà phát triển nào 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ó trên trang web

Có hai cách để bạn có thể chỉ định các sản phẩm API 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ư minh hoạ bên dưới:

Để biết thêm thông tin về mức độ ảnh hưởng của cấp truy cập đến khả năng sử dụng sản phẩm API trong cổng thông tin dành cho nhà phát triển Drupal 7, hãy xem phần 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ò

Bằng cách bật mô-đun Drupal API Product Role Access (Truy cập theo vai trò 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 quản trị hoặc tạo nội dung.
  2. Xem xét các vai trò và quyền chỉ định người dùng trên cổng thông tin dành cho nhà phát triển:
    • Chọn People (Nhân viên) > Permissions (Quyền) > Roles (Vai trò) trong trình đơn quản trị Drupal và thêm hoặc chỉnh sửa vai trò và quyền của nhà phát triển (nếu cần).
    • Chọn People (Nhân viên) trong trình đơn quản trị Drupal rồi chỉnh sửa các vai trò và quyền của người dùng nếu cần.
  3. Chọn Configuration > Dev Portal > API Product Role Access (Cấu hình > Cổng phát triển > Quyền truy cập theo vai trò sản phẩm API) trong trình đơn quản trị Drupal.
  4. Chọn những vai trò mà bạn muốn có thể 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 sản phẩm API với ứng dụng

Để đăng ký một ứ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 để 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 tất cả ứng dụng.

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

  • Khô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 chọn một sản phẩm API, nhưng không bắt buộc.
  • Yêu cầu chọn một sản phẩm API.
  • Cho phép chọn nhiều Sản phẩm API nhưng không bắt buộc phải chọn.
  • Cho phép 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 tuỳ chọn 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 quản trị hoặc tạo nội dung.
  2. Chọn Cấu hình > Cài đặt cổng thông tin dành 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 khu vực Cài đặt sản phẩm API.
  4. Trong mục Xử lý sản phẩm API, hãy chọn tuỳ chọn kiểm soát lựa chọn sản phẩm API.
  5. Nếu bạn chỉ định tuỳ 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 một sản phẩm mặc định trong phần Sản phẩm API mặc định.
  6. Trong phần 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 sản phẩm API.
  7. Lưu cấu hình.

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

Nếu proxy API trong sản phẩm API của bạn sử dụng "OAuth ba bên" (loại cấp mã uỷ quyền), thì nhà phát triển cần chỉ định một URL gọi lại khi đăng ký ứng dụng. URL gọi lại thường chỉ định URL của một ứng dụng được chỉ định để thay mặt ứng dụng khách nhận mã uỷ quyền. Ngoài ra, chuỗi URL này được dùng để xác thực. Ứng dụng phải gửi URL này đến 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 quản trị hoặc tạo nội dung.
  2. Chọn Cấu hình > Cài đặt cổng thông tin dành 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 khu vực 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 tuỳ 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 và 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 có thể hiển thị thông tin phân tích về mức sử dụng ứng dụng. Nếu bật tính năng hiển thị số liệu phân tích, 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 quản trị hoặc tạo nội dung.
  2. Chọn Configuration > Dev Portal > Application Settings (Cấu hình > Cổng thông tin dành 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 khu vực Cài đặt hiệu suất ứng dụng.
  4. Đánh dấu vào hộp đánh dấu Show Developer App analytics tab (Hiện thẻ Phân tích ứng dụng dành cho nhà phát triển).
  5. Chọn Thử nghiệm hoặc Sản xuất cho Môi trường để truy vấn dữ liệu phân tích. Đối với cổng thông tin công khai, thông thường bạn sẽ chọn Sản xuất.
  6. Lưu cấu hình.

Cách hiển thị số liệu phân tích trên trang web này 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 Analytics cho ứng dụng.
  3. Chọn loại số liệu phân tích cần hiển thị và phạm vi ngày:
  4. Thông tin đã chọn sẽ xuất hiện:

Cấp hoặc thu hồi khoá API cho sản phẩm API theo cách thủ công

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 cho ứng dụng đó. Sau đó, nhà phát triển sử dụng khoá API đó để truy cập vào các proxy API do sản phẩm API liên kết với ứng dụng đó cung cấp.

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à:

  • Tự động – Cổng thông tin sẽ trả về một khoá API đã phê duyệt cho sản phẩm API 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 thông tin sẽ trả về một khoá API khi nhà phát triển đăng ký ứng dụng, nhưng khoá này sẽ không được kích hoạt cho bất kỳ sản phẩm API nào sử dụng quy trình phê duyệt khoá 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, trước khi nhà phát triển có thể sử dụng khoá đó để truy cập vào sản phẩm API. Sau này, bạn có thể thu hồi khoá được phê duyệt theo cách thủ công.

Hãy xem phần 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 bằng tính năng Xác nhận khoá tự động và một số sản phẩm bằng tính năng Xác nhận khoá thủ công. Nhà phát triển có thể sử dụng khoá API được trả về cho tất cả các sản phẩm API được phê duyệt tự động ngay lập tức trong khi chờ phê duyệt cuối cùng cho những sản phẩm yêu cầu phê duyệt 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 chọn tên ứng dụng trên trang Ứng dụng của tôi, sau đó 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 phương thức 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 quy trình Phê duyệt tự động và việc 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ý Edge với tư cách là người dùng có quyền quản trị đối với tổ chức của bạn.
  2. Chọn API Platform (Nền tảng API) trong hộp thả xuống ở góc trên bên phải.
  3. Chọn Xuất bản > Ứng dụng dành cho nhà phát triển để mở danh sách ứng dụng dành cho nhà phát triển.
  4. Chọn nút Đ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 về ứng dụng, hãy chọn nút 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, trong phần Thao tác:
    • Để 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 phần Hành động cho một 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 và ứng dụng API vào bộ nhớ đệm

Thông tin về các sản phẩm API và ứng dụng dành cho nhà phát triển được lưu trữ từ xa trên cổng thông tin trên Apigee Edge. Điều đó có nghĩa là bạn có thể thực hiện các thay đổi đối với các 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 phải truy cập vào cổng thông tin. Ví dụ: khi quản trị viên phụ trách phầ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 rằng cổng thông tin luôn đồng bộ với phần phụ trợ của Edge, bạn có thể kích hoạt việc cập nhật bộ nhớ đệm của cổng thông tin theo cách thủ công, tự động cập nhật bộ nhớ đệm khi công việc cron 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 cron để chạy thường xuyên, chẳng hạn như 5 hoặc 10 phút một lần, thì bạn có thể không muốn chi phí cập nhật các sản phẩm API và bộ nhớ đệm ứng dụng của nhà phát triển thường xuyên như vậy. 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 chạy mỗi giờ hoặc hai giờ, 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 sản phẩm API và bộ nhớ đệm ứng dụng dành cho nhà phát triển mỗi khi cron chạy.

Cách chỉ định xem có 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 hay không mỗi khi cron chạy:

  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 quản trị hoặc tạo nội dung.
  2. Trong trình đơn Drupal, hãy chọn Configuration > Dev Portal Settings > Application Settings (Cấu hình > Cài đặt cổng thông tin dành cho nhà phát triển > Cài đặt ứng dụng).
  3. Đánh dấu hoặc bỏ đánh dấu Tạo lại bộ nhớ đệm 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 quản trị hoặc tạo nội dung.
  2. Trong trình đơn Drupal, hãy chọn Biểu tượng trang chủ > Xoá tất cả bộ nhớ đệm.

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

Khi nhà phát triển đăng ký một ứ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 thông tin, chẳng hạn 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. Trang này cho phép bạn thêm các 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 nhiều phần tử HTML, chẳng hạn như hộp văn bản, nút chọn, hộp đánh dấu và nhiều phần tử khác
  • Có thể được đặt để xuất hiện ở bất kỳ vị trí 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ó trong 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 cho thấy một trường bắt buộc cho Mã khách hàng và một trường không bắt buộc cho nền tảng mục tiêu:

Khi bạn thêm các trường mới vào biểu mẫu, các giá trị 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 chỉnh sửa các trường đó trên Edge hoặc sử dụng API quản lý Edge để truy cập vào các trường đó từ một tập lệnh.

Ví dụ: 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 mục 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ị trường mới sẽ xuất hiện trong khu vực Thuộc tính tuỳ chỉnh của trang, với tên tương ứng với tên nội bộ của trường:

Các giá trị trường cũng xuất hiện trong khu vực 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ị này 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.

Các 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 giao diện quản trị. Nhà phát triển Drupal có thể thực hiện các tuỳ chỉnh bổ sung, bao gồm cả việc sửa đổi trang "Ứng dụng của tôi" bằng cách sử dụng các trình bổ trợ tuỳ chỉnh. Để 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 quản trị hoặc tạo nội dung.
  2. Đảm bảo bạn đã bật mô-đun Quản lý thuộc tính ứng dụng DevConnect.
  3. Chọn Configuration (Cấu hình) > Dev Portal Settings (Cài đặt cổng thông tin dành cho nhà phát triển) > Dev Portal App Attributes (Thuộc tính ứng dụng cổng thông tin dành cho nhà phát triển) trong trình đơn quản trị Drupal.
  4. Chọn nút Add Dev Portal App Attribute (Thêm thuộc tính ứng dụng trên Cổng 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 hiển thị ở trên, hãy sử dụng các chế độ cài đặt sau:
    • Tên nội bộ = cust_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
    • Description (Nội dung mô tả) = Nhập mã khách hàng của bạn.
    • Chọn hộp đánh dấu Yêu cầu thuộc tính này
    • Chọn hộp đánh dấu 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 dành cho nhà phát triển.
  6. Chọn Lưu thay đổi.
  7. Chọn Biểu tượng trang chủ > Xoá tất cả bộ nhớ đệm trong trình đơn Drupal.
    Bạn có thể phải xoá bộ nhớ đệm của trình duyệt trước khi 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 cho nhà phát triển chỉ định nền tảng cho ứng dụng, hãy đặt thuộc tính trường thành:

  • Tên nội bộ = intended_platforms
  • Tên công khai = Nền tảng
  • Description (Mô tả) = Chỉ định một hoặc nhiều nền tảng cho ứng dụng.
  • Bỏ đánh dấu hộp 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 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 dành cho nhà phát triển.

Cách sắp xếp lại 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 quản trị hoặc tạo nội dung.
  2. Chọn Configuration (Cấu hình) > Dev Portal Settings (Cài đặt cổng thông tin dành cho nhà phát triển) > Dev Portal App Attributes (Thuộc tính ứng dụng cổng thông tin dành 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.