Đăng ký nhà phát triển ứng dụng

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X. thông tin

Đăng ký và quản lý nhà phát triển ứng dụng theo nội dung mô tả trong các phần sau. (Đăng ký ứng dụng là một quy trình riêng biệt, như mô tả trong phần Đăng ký ứng dụng và quản lý khoá API).

Giới thiệu

Edge mang lại nhiều lợi ích hoàn toàn phụ thuộc vào việc biết ai đang gọi API của bạn. Ví dụ: tính năng bảo mật API, quản lý lưu lượng truy cập và một lượng lớn dữ liệu phân tích phụ thuộc vào việc biết ai đang gọi. Và làm cách nào Edge biết được ai đang gọi API của bạn? Bằng cách đọc thông tin riêng biệt trong mỗi lệnh gọi API, chẳng hạn như mã nhận dạng người dùng, khoá API hoặc mã thông báo OAuth. Thông tin duy nhất đó sẽ khoá hoặc mở khoá chức năng mà bạn tạo trong các proxy API, giúp bạn kiểm soát hoàn toàn quyền truy cập và hành vi của API.

Đó là lý do nhà phát triển ứng dụng cần đăng ký để sử dụng các API của bạn. Sau khi được thêm, nhà phát triển sẽ đăng ký ứng dụng của họ, chọn API mà họ muốn sử dụng và nhận thông tin đăng nhập API duy nhất (khoá và bí mật của người dùng) cần thiết để truy cập vào API của bạn.

Cách đăng ký nhà phát triển ứng dụng

Đăng ký nhà phát triển ứng dụng bằng một trong các phương thức sau:

Đề xuất về cách quản lý tài khoản nhà phát triển trên cổng thông tin dành cho nhà phát triển

Apigee khuyến nghị bạn quản lý tài khoản nhà phát triển ngay trên cổng thông tin cho nhà phát triển.

Nếu bạn đang sử dụng cổng thông tin tích hợp, thì đây là cách duy nhất để đảm bảo rằng các tài khoản nhà phát triển trên cổng thông tin tích hợp và Edge luôn đồng bộ hoá.

Nếu bạn sử dụng cổng thông tin cho nhà phát triển dựa trên Drupal, thì việc quản lý trực tiếp tài khoản nhà phát triển trên cổng thông tin cho nhà phát triển sẽ mang lại những lợi ích sau:

  • Khi thêm một nhà phát triển thông qua giao diện quản trị trên cổng thông tin, bạn có thể đặt mật khẩu của nhà phát triển cho cổng thông tin và kích hoạt một nội dung email tự động gửi đến nhà phát triển.

    Khi thêm hoặc sửa đổi một nhà phát triển bằng Edge, hệ thống sẽ không gửi email cho nhà phát triển và bạn không thể đặt mật khẩu cho nhà phát triển trên cổng thông tin. Do đó, nhà phát triển phải đặt lại mật khẩu trên cổng thông tin thì mới có thể đăng nhập vào cổng thông tin.

  • Mọi thay đổi đối với tài khoản của nhà phát triển trên cổng thông tin đều được tự động gửi đến Edge.

Nếu quyết định quản lý tài khoản nhà phát triển dựa trên Drupal bằng Edge, bạn phải đồng bộ hoá nhà phát triển ứng dụng giữa cổng thông tin và Edge.

Khám phá trang dành cho nhà phát triển

Truy cập và khám phá trang Nhà phát triển bằng giao diện người dùng Edge và giao diện người dùng Edge cổ điển.

Edge

Cách truy cập vào trang Nhà phát triển bằng giao diện người dùng Edge:

  1. Đăng nhập vào apigee.com/edge.
  2. Chọn Xuất bản > Nhà phát triển trong thanh điều hướng bên trái.

Trang Nhà phát triển sẽ xuất hiện.

Như minh hoạ trong hình, trang Nhà phát triển cho phép bạn:

Classic Edge (Private Cloud)

Cách truy cập vào trang Nhà phát triển bằng giao diện người dùng Edge cũ:

  1. Đăng nhập vào http://ms-ip:9000, trong đó ms-ip là địa chỉ IP hoặc tên DNS của nút Máy chủ quản lý.
  2. Chọn Xuất bản > Nhà phát triển trong thanh điều hướng trên cùng.

Trang Nhà phát triển sẽ xuất hiện.

Thêm nhà phát triển

Cách thêm nhà phát triển:

  1. Truy cập vào trang Nhà phát triển.
  2. Nhấp vào + Nhà phát triển.
  3. Nhập thông tin chi tiết về nhà phát triển, bao gồm cả tên, họ, email và tên người dùng.
  4. Nhấp vào Tạo.

Xem và chỉnh sửa thông tin chi tiết về nhà phát triển

Xem và chỉnh sửa thông tin chi tiết về nhà phát triển. Đối với những tổ chức đã bật tính năng kiếm tiền, bạn có thể chỉnh sửa các thuộc tính tuỳ chỉnh của tính năng kiếm tiền được xác định trong phần Định cấu hình thuộc tính kiếm tiền.

Cách xem và chỉnh sửa thông tin chi tiết về nhà phát triển:

  1. Truy cập vào trang Nhà phát triển.
  2. Nhấp vào hàng của nhà phát triển mà bạn muốn xem và chỉnh sửa để mở thông tin chi tiết về nhà phát triển.
  3. Trong phần Chi tiết, thông tin sau đây sẽ xuất hiện. Chỉnh sửa thông tin nhà phát triển (bắt buộc).
    Chi tiết Mô tả
    Thông tin chi tiết Họ và tên, tên người dùng và email của nhà phát triển; trạng thái và thời gian đăng ký; cũng như mã nhận dạng nhà phát triển.
    Để chỉnh sửa thông tin chi tiết về nhà phát triển, hãy nhấp vào một trong các trường sau:
    • Tên
    • Họ
    • Email
    • Tên người dùng
    Sửa đổi nội dung rồi nhấn phím Enter để xác nhận thay đổi.
    Thuộc tính tùy chỉnh Các thuộc tính tuỳ chỉnh được xác định cho nhà phát triển. Định cấu hình các thuộc tính tuỳ chỉnh (nếu cần). Để biết thêm thông tin, hãy xem:
    Ứng dụng Ứng dụng do nhà phát triển đăng ký. Xem phần Đăng ký ứng dụng.
  4. Kích hoạt hoặc huỷ kích hoạt nhà phát triển trong trường Trạng thái.
    Để biết thêm thông tin, hãy xem phần Kích hoạt và huỷ kích hoạt nhà phát triển.

Với Apigee Edge cho Đám mây công cộng, Edge sẽ giữ các thực thể sau trong bộ nhớ đệm trong tối thiểu 180 giây sau khi các thực thể được truy cập.

  • Mã truy cập OAuth. Điều này có nghĩa là mã thông báo đã bị thu hồi vẫn có thể hoạt động trong tối đa 3 phút, cho đến khi hết hạn mức bộ nhớ đệm.
  • Các thực thể Key Management Service (KMS) (Ứng dụng, Nhà phát triển, Sản phẩm API).
  • Thuộc tính tuỳ chỉnh trên mã thông báo OAuth và các thực thể KMS.

Quản lý thuộc tính tuỳ chỉnh cho nhà phát triển

Thêm tối đa 18 thuộc tính tuỳ chỉnh cho mỗi nhà phát triển, bao gồm cả các thuộc tính kiếm tiền được mô tả trong phần Định cấu hình thuộc tính kiếm tiền.

Cách quản lý các thuộc tính tuỳ chỉnh:

  1. Truy cập vào trang Nhà phát triển.
  2. Nhấp vào hàng có tên nhà phát triển mà bạn muốn quản lý thuộc tính tuỳ chỉnh để mở thông tin chi tiết về nhà phát triển.
  3. Nhấp vào dấu + trong mục Thuộc tính tuỳ chỉnh.
  4. Nhập tên thuộc tính và giá trị.
  5. Nhấp vào .
  6. Để xoá một thuộc tính tuỳ chỉnh, hãy di chuyển con trỏ lên thuộc tính đó rồi nhấp vào biểu tượng trong trình đơn thao tác.

Kích hoạt và huỷ kích hoạt nhà phát triển

Khi một nhà phát triển ứng dụng tự đăng ký trong cổng thông tin của bạn, bạn có thể định cấu hình xem họ có hoạt động theo mặc định hay không.

Khi không hoạt động, nhà phát triển vẫn có thể đăng nhập vào cổng thông tin cho nhà phát triển và tạo ứng dụng, nhưng không có khoá API tương ứng nào hoạt động. Các ứng dụng của nhà phát triển vẫn giữ nguyên trạng thái đã được phê duyệt (hoặc trạng thái khác), cũng như khoá API, ngay cả khi chúng không hợp lệ trong thời gian nhà phát triển không hoạt động.

Cách kích hoạt hoặc huỷ kích hoạt một nhà phát triển:

  1. Truy cập vào trang Nhà phát triển.
  2. Nhấp vào hàng có tên nhà phát triển mà bạn muốn kích hoạt hoặc huỷ kích hoạt để mở thông tin chi tiết về nhà phát triển.
  3. Trong phần Chi tiết, hãy đặt trường Trạng thái thành Đang hoạt động hoặc Không hoạt động (nếu cần).
  4. Lặp lại các bước nếu nhà phát triển thuộc nhiều tổ chức.

Xuất dữ liệu xuất bản

Xuất dữ liệu xuất bản sau đây dưới dạng tệp chứa các giá trị được phân tách bằng dấu phẩy (CSV):

  • Chi tiết của Nhà phát triển
  • Thông tin chi tiết về nhà phát triển, ứng dụng và sản phẩm API

Cách xuất dữ liệu xuất bản:

  1. Truy cập vào trang Nhà phát triển.
  2. Nhấp vào Xuất tệp CSV...
  3. Chọn Nhà phát triển hoặc Nhà phát triển, Ứng dụng và Sản phẩm trong trình đơn thả xuống.

Dữ liệu xuất bản đã chọn sẽ được tải xuống dưới dạng tệp CSV.

Xoá nhà phát triển

Cách xoá nhà phát triển:

  1. Truy cập vào trang Nhà phát triển.
  2. Đặt con trỏ lên hàng của nhà phát triển mà bạn muốn xoá để trình đơn thao tác xuất hiện.
  3. Nhấp vào .
  4. Nhấp vào Xoá để xác nhận xoá.

Đồng bộ hoá nhà phát triển ứng dụng giữa cổng thông tin và Edge

Nếu bạn đang sử dụng một cổng thông tin cho nhà phát triển dựa trên Drupal để xuất bản API, thì những thay đổi đối với nhà phát triển ứng dụng bằng Edge sẽ không được truyền đến cổng thông tin. Bạn phải đăng nhập vào cổng thông tin với tư cách là quản trị viên cổng thông tin và đồng bộ hoá cổng thông tin với Edge để những thay đổi đó xuất hiện trên cổng thông tin.

Để đồng bộ hoá cổng thông tin cho nhà phát triển với các nhà phát triển ứng dụng được xác định trên Edge, hãy tham khảo các phần sau:

Nhóm nhà phát triển thành các công ty

Với tính năng kiếm tiền, công ty là một tập hợp gồm những nhà phát triển được quản lý dưới dạng một thực thể duy nhất. Công ty có thể là bất kỳ nhóm nào phù hợp với tổ chức của bạn, chẳng hạn như đơn vị kinh doanh, dòng sản phẩm hoặc bộ phận. Việc nhóm các nhà phát triển thành công ty sẽ hữu ích khi bạn cần có nhiều nhà phát triển được liên kết với một pháp nhân duy nhất. Ví dụ: bạn có thể cần thiết lập nhiều công ty cho mục đích thanh toán. Tuy nhiên, nhà phát triển trong tổ chức của bạn không cần phải liên kết với một công ty. Xin lưu ý rằng nhà phát triển luôn là một thực thể duy nhất, được xác định riêng biệt bằng phần tử email. Nếu một nhà phát triển là thành viên của một công ty, bạn sẽ thấy Tên công ty trên trang Nhà phát triển.

Để biết thêm thông tin về cách quản lý các công ty và nhà phát triển để kiếm tiền, hãy xem bài viết Quản lý các công ty và nhà phát triển.

Định cấu hình các thuộc tính kiếm tiền

Khi chỉnh sửa nhà phát triển bằng giao diện người dùng hoặc tạo hoặc chỉnh sửa nhà phát triển bằng API, bạn có thể định cấu hình các thuộc tính kiếm tiền được xác định trong bảng sau. Ban đầu, bạn định cấu hình các thuộc tính kiếm tiền cho tổ chức khi chỉnh sửa hồ sơ tổ chức.

Tên trường Tên thuộc tính tùy chỉnh Mô tả
Địa chỉ MINT_DEVELOPER_ADDRESS

Địa chỉ của nhà phát triển, bao gồm các trường sau: Địa chỉ (dòng 1 và 2), Thành phố, Tiểu bang, Mã bưu chính và Quốc gia.
Hồ sơ thanh toán MINT_BILLING_PROFILE

Chu kỳ thanh toán cho tổ chức của bạn. Các giá trị hợp lệ bao gồm:

  • PRORATED: Phí được tính dựa trên số ngày sử dụng một sản phẩm API trong một tháng dương lịch.
  • CALENDAR_MONTH: Bạn sẽ thanh toán hằng tháng.
Loại thanh toán MINT_BILLING_TYPE

Mô hình thanh toán của nhà phát triển được dùng để lập hoá đơn. Giá trị có thể là một trong những giá trị sau:

  • TRẢ TRƯỚC: Nhà phát triển trả trước cho việc sử dụng một sản phẩm API. Tiền sẽ được khấu trừ vào số dư của nhà phát triển khi sản phẩm API được sử dụng. Nhà phát triển phải duy trì số dư trả trước đủ để mua sản phẩm API.
  • POSTPAID: Nhà phát triển được tính phí hằng tháng (thông qua hoá đơn) cho việc sử dụng các sản phẩm API. Nhà phát triển thanh toán cho việc sử dụng các sản phẩm API dựa trên các điều khoản thanh toán do(các) gói có trong hoá đơn đặt ra.
  • BOTH: Hỗ trợ cả hai loại thanh toán. Giá trị mặc định là PREPAID.

Xem phần Định cấu hình các loại hình thức thanh toán trả trước và trả sau bằng API.

Danh mục MINT_DEVELOPER_CATEGORY Danh mục nhà phát triển mà bạn muốn thêm nhà phát triển vào. Danh mục nhà phát triển là một nhóm các nhà phát triển hoặc công ty có đặc điểm tương tự nhau. Để biết thêm thông tin, hãy xem bài viết Quản lý danh mục nhà phát triển.
Mã công ty MINT_COMPANY_ID Mã nhận dạng công ty (nếu có). Để biết thêm thông tin, hãy xem phần Nhóm nhà phát triển thành các công ty.
Loại nhà phát triển MINT_DEVELOPER_TYPE Apigee không dùng thuộc tính này.

Loại nhà phát triển. Các giá trị hợp lệ bao gồm: TRUSTED hoặc UNTRUSTED
Là bên môi giới MINT_IS_BROKER Cờ chỉ định liệu doanh thu có dựa trên giá trị ròng hay không.
Tên pháp lý MINT_DEVELOPER_LEGAL_NAME Tên pháp lý của nhà phát triển sẽ được dùng trong tất cả các báo cáo.
Lưu ý: Thuộc tính này là bắt buộc nếu nhà phát triển không thuộc một công ty và muốn đăng ký một gói cước đã xuất bản.
Tự lập hoá đơn MINT_HAS_SELF_BILLING Cờ chỉ định xem hoá đơn tự lập có được bật hay không. Nếu được bật (true), tính năng kiếm tiền sẽ tạo hoá đơn tự lập thay vì báo cáo chia sẻ doanh thu. Hoá đơn tự lập là một chứng từ tài chính nêu rõ số tiền phải trả cho nhà phát triển. Đây là hoá đơn gửi cho Nhà cung cấp API thay mặt cho nhà phát triển.
Mã số miễn thuế MINT_TAX_EXEMPT_AUTH_NO Mã số miễn thuế của chính phủ (nếu có).
Thuế suất MINT_APPROX_TAX_RATE Thuế suất ước tính đối với nhà phát triển. Chỉ định giá trị thập phân có tối đa 3 ký tự trước dấu thập phân và 4 ký tự sau dấu thập phân.

Quản lý nhà phát triển bằng API

Quản lý nhà phát triển bằng Developer API.

Khi tạo và cập nhật nhà phát triển bằng API, bạn có thể định cấu hình các thuộc tính kiếm tiền như mô tả trong phần Định cấu hình thuộc tính kiếm tiền, nếu cần.