Đăng ký nhà phát triển ứ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

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

Giới thiệu

Edge cung cấp nhiều lợi ích hoàn toàn phụ thuộc vào việc biết ai gọi API của bạn. Ví dụ: bảo mật API, quản lý lưu lượng truy cập và một lượng dữ liệu phân tích khá lớn phụ thuộc vào việc biết ai đang gọi. Và làm thế nào Edge biết được ai đang gọi API của bạn? Bằng cách đọc thông tin duy nhấ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 đó khoá hoặc mở khoá chức năng mà bạn tích hợp vào proxy API, cho phép bạn toàn quyền kiểm soát hành vi và quyền truy cập 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 thêm ứng dụng, nhà phát triển sẽ đăng ký ứng dụng, chọn các API họ muốn sử dụng và nhận thông tin đăng nhập API riêng biệt (khoá và khoá bí mật dành cho người tiêu dùng) cần thiết để truy cập vào API của bạn.

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

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

Đề xuất về việc 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 bạn nên quản lý tài khoản nhà phát triển ngay trên cổng thông tin dành cho nhà phát triển.

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

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

  • Khi thêm nhà phát triển thông qua giao diện quản trị viên trên cổng, bạn có thể đặt mật khẩu của nhà phát triển cho cổng và kích hoạt email tự động gửi cho 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 cũng như 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 của mình trên cổng thông tin trước khi 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 sẽ tự động được 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ộ hóa nhà phát triển ứng dụng giữa cổng thông tin và Edge.

Khám phá trang Nhà phát triển

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

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 ở thanh điều hướng bên trái.

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

Như được đánh dấu trong hình, trang Nhà phát triển cho phép bạn:

Phiên bản cũ (Đám mây riêng tư)

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

  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 ở 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 dành cho 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 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 các 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 liên quan đến việc kiếm tiền được xác định trong bài viết Đị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 dành cho 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ẽ hiển thị. Chỉnh sửa thông tin nhà phát triển theo yêu cầu.
    Chi tiết Nội dung 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à 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 bất kỳ trường nào sau đây:
    • 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 nội dung thay đổi.
    Thuộc tính tùy chỉnh 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, theo yêu cầu. Để biết thêm thông tin, hãy xem các bài viết:
    Chiến dịch Quảng cáo ứng dụng Những ứng dụng mà 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 bài viết Kích hoạt và huỷ kích hoạt nhà phát triển.

Với Apigee Edge cho Cloud công cộng, Edge sẽ lưu 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ể thành công trong tối đa 3 phút cho đến khi giới hạn bộ nhớ đệm của mã hết hạn.
  • Thực thể Dịch vụ quản lý khoá (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à 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 như mô tả trong bài viết Định cấu hình các 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 dành cho Nhà phát triển.
  2. Nhấp vào hàng của nhà phát triển mà bạn muốn quản lý các 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 và giá trị thuộc tính.
  5. Nhấp vào .
  6. Để xoá thuộc tính tuỳ chỉnh, hãy đặt con trỏ lên thuộc tính đó và nhấp vào trong trình đơn thao tác.

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

Khi 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 nhà phát triển không hoạt động, nhà phát triển vẫn có thể đăng nhập vào cổng thông tin dành cho nhà phát triển và tạo ứng dụng, nhưng sẽ không có khoá API tương ứng nào hoạt động. Ứ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), giống như các khoá API, mặc dù các khoá này không hợp lệ khi nhà phát triển không hoạt động.

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

  1. Truy cập vào trang dành cho Nhà phát triển.
  2. Nhấp vào hàng của 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, theo yêu cầu.
  4. Lặp lại các bước này nếu nhà phát triển thuộc nhiều tổ chức.

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

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

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

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

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

Dữ liệu xuất bản đã chọn đượ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 dành cho 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á để hiển thị trình đơn thao tác.
  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 dành cho nhà phát triển dựa trên Drupal để phát hành API, thì các 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 này. Bạn phải đăng nhập vào cổng với tư cách là quản trị viên cổng và đồng bộ hoá cổng thông tin với Edge để những thay đổi đó xuất hiện trên cổng.

Để đồng bộ hoá cổng thông tin dành cho nhà phát triển của bạn với các nhà phát triển ứng dụng được xác định trong 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 mô hình kiếm tiền, mỗi công ty là một tập hợp gồm các nhà phát triển do một pháp nhân duy nhất quản lý. 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 nhà phát triển thành các công ty sẽ hữu ích khi bạn cần liên kết nhiều nhà phát triển với một pháp nhân công ty duy nhất. Ví dụ: bạn có thể cần thành lập các công ty khác nhau cho mục đích thanh toán. Tuy nhiên, các 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 duy nhất bằng phần tử email. Nếu nhà phát triển là thành viên của một công ty, thì 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 đối với hoạt động 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/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 tuỳ chỉnh Nội dung mô tả
Address (Địa chỉ) MINT_DEVELOPER_ADDRESS

Địa chỉ của nhà phát triển, bao gồm các trường sau đây: Đị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: Thanh toán dựa trên số ngày mà một sản phẩm API được sử dụng trong một tháng theo lịch.
  • CALENDAR_MONTH: Việc thanh toán được thực hiệ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 dùng để thanh toán. Giá trị có thể là một trong những giá trị sau:

  • TRẢ TRƯỚC: Nhà phát triển thanh toán trước để sử dụng một sản phẩm API. Tiền được khấu trừ từ 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.
  • TRẢ SAU: Nhà phát triển được tính phí hằng tháng (qua hoá đơn) đối với 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 thời hạn thanh toán do(các) gói ghi trên hoá đơn đặt ra.
  • BOTH: Hỗ trợ một trong hai loại thanh toán. Giá trị mặc định là PREPAY.

Xem bài viết Định cấu hình loại 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. 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 phần Quản lý danh mục nhà phát triển.
Mã công ty MINT_COMPANY_ID Mã 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 Thuộc tính này không được Apigee sử dụng.

Kiểu nhà phát triển. Các giá trị hợp lệ bao gồm: TRUSTED hoặc UNTRUSTED
Là người môi giới MINT_IS_BROKER Cờ cho biết 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 sử dụng trong tất 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 tham gia nhóm với một công ty và muốn đăng ký một gói giá đã phát hành.
Tự thanh toán MINT_HAS_SELF_BILLING Cờ cho biết liệu hoá đơn tự thanh toán có đang bật hay không. Nếu bạn bật (true), hoạt động kiếm tiền sẽ tạo một hoá đơn tự thanh toán thay vì bảng sao kê chia sẻ doanh thu. Hoá đơn tự thanh toán là một chứng từ tài chính ghi chi tiết số tiền phải thanh toán cho nhà phát triển. Khoản thanh toán này đóng vai trò là hoá đơn cho Nhà cung cấp API thay mặt cho nhà phát triển.
Mã số uỷ quyền miễn thuế MINT_TAX_EXEMPT_AUTH_NO Mã số miễn thuế do chính phủ cấp, nếu có.
Thuế suất MINT_APPROX_TAX_RATE Thuế suất ước tính cho nhà phát triển. Chỉ định một giá trị thập phân có số lượng tối đa là 3 ký tự trước số thập phân và 4 ký tự sau số 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 API Nhà phát triển.

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