Bạn đang xem tài liệu về Apigee Edge.
Tham khảo tài liệu về Apigee X. thông tin
Có một số khái niệm phổ biến mang một ý nghĩa riêng trong quá trình ứng dụng Apigee.
| Thuật ngữ | Định nghĩa |
|---|---|
| API | Một proxy hoạt động như một thành phần tượng trưng cho API hiện tại của bạn. Thay vì gọi API hiện có, nhà phát triển bắt đầu gọi API mới do Apigee tạo ra. Thành phần này tách riêng giao diện công khai khỏi API phụ trợ, giúp nhà phát triển không gặp phải những thay đổi đối với phần phụ trợ, đồng thời cho phép bạn đổi mới ở vùng biên mà không ảnh hưởng đến các nhóm phát triển nội bộ. Khi bạn thực hiện các thay đổi trong phần phụ trợ, nhà phát triển sẽ tiếp tục gọi cùng một API mà không bị gián đoạn. Trong các trường hợp nâng cao hơn, Apigee cho phép bạn hiển thị nhiều giao diện cho cùng một API, giúp bạn có thể tuỳ chỉnh chữ ký của một API nhằm đáp ứng đồng thời nhu cầu của nhiều nhóm nhà phát triển. |
| Đường dẫn cơ sở và tài nguyên của API | API được tạo thành từ đường dẫn cơ sở và một nhóm tài nguyên (còn được gọi là đường dẫn tài nguyên). Đối với mỗi API, bạn sẽ xác định một URL gốc và nhiều đường dẫn tài nguyên. Bạn có thể coi API đơn giản là một tập hợp URI, tất cả đều có chung một đường dẫn cơ sở. Để giúp bạn quản lý các API của mình dễ dàng hơn, Apigee tăng cường các URI thô này bằng tên hiển thị và nội dung mô tả. |
| Ứng dụng sử dụng API | Từ đồng nghĩa với "nhà phát triển ứng dụng", sử dụng API do nhà cung cấp API tạo ra. |
| Nhà phát triển API | Kỹ sư phần mềm trong một tổ chức nhà cung cấp API và là người xây dựng API. Những API đó được nhà phát triển ứng dụng (đối tượng sử dụng API) sử dụng để xây dựng ứng dụng. |
| Gói API | Tập hợp các sản phẩm API được cung cấp cho nhà phát triển dưới dạng một gói và thường liên kết với một gói giá. |
| Sản phẩm API | Một tập hợp tài nguyên API (URI) kết hợp với một gói dịch vụ và được cung cấp cho các nhà phát triển dưới dạng một gói. Sản phẩm API cũng có thể bao gồm một số siêu dữ liệu dành riêng cho doanh nghiệp của bạn để theo dõi hoặc phân tích. Bạn có thể kiếm tiền từ một hoặc nhiều tài nguyên bằng cách đưa những tài nguyên đó vào sản phẩm API. Sau đó, chúng có thể được gói vào một gói API để kiếm tiền. |
| Nhà cung cấp API | Nhà cung cấp API xây dựng các API (sử dụng Edge) để người dùng API (nhà phát triển ứng dụng) sử dụng. |
| nhà phát triển ứng dụng | Trong Edge, nhà phát triển ứng dụng đăng ký ứng dụng với nhà cung cấp API. Đây là cách nhà phát triển ứng dụng nhận được khoá API cần thiết để gọi proxy API của nhà cung cấp. |
| ứng dụng | Nhà phát triển dùng ứng dụng để truy cập vào tài nguyên trong các sản phẩm API của bạn. Khi tạo một ứng dụng, bạn sẽ chọn sản phẩm API để đưa vào và Apigee sẽ tạo một khoá. Mỗi ứng dụng có một khoá duy nhất cung cấp quyền truy cập vào nhiều sản phẩm API. Ứng dụng cho phép bạn kiểm soát những người có thể truy cập vào tài nguyên của bạn. Bạn có thể kiểm soát những ai có quyền truy cập vào các sản phẩm API của mình bằng cách thu hồi và làm mới khoá của ứng dụng. Ngoài ra, bạn có thể kiểm soát quyền truy cập vào các gói tài nguyên bằng cách thu hồi hoặc xoá quyền truy cập vào các sản phẩm trong một ứng dụng. |
| thông tin chi tiết về số dư | Đối với nhà phát triển trả trước, số dư trong tài khoản của nhà phát triển. |
| điều chỉnh đóng | Mức điều chỉnh đã được áp dụng trong chứng từ thanh toán được công bố. |
| tháng thanh toán đã đóng | Một tháng dương lịch đầy đủ có chứng từ thanh toán được xuất bản. |
| giới hạn tuỳ chỉnh | Một giới hạn (chẳng hạn như giới hạn về số lượng giao dịch trên một sản phẩm API) mà bạn có thể thiết lập một cách rõ ràng bằng phương thức kiếm tiền. Còn được gọi là giới hạn tường minh. |
| gói giá cho danh mục dành cho nhà phát triển | Gói giá áp dụng cho tất cả nhà phát triển trong một danh mục cụ thể và tất cả các nhà phát triển trong danh mục đó đều có thể mua. |
| gói giá dành cho nhà phát triển | Gói giá áp dụng cho một nhà phát triển cụ thể và chỉ nhà phát triển đó mới có thể mua. |
| nhân viên hỗ trợ được tiết lộ | Trong luật thương mại, một người được uỷ quyền thay mặt cho một người khác (được gọi là người uỷ thác) để tạo ra một mối quan hệ pháp lý với một bên thứ ba. Về mặt kiếm tiền, mô hình thuế có thể được thiết lập cho kế hoạch doanh thu dùng chung, trong đó nhà cung cấp API đóng vai trò là đại lý được công bố của nhà phát triển để thu doanh thu (và có thể cả thuế bán hàng) thay mặt cho nhà phát triển. |
| mô hình thuế được công bố | Một mô hình thuế trong đó nhà cung cấp API đóng vai trò là người đại diện được công bố của nhà phát triển. |
| môi trường | Ngữ cảnh thực thi thời gian chạy cho API. Bạn phải triển khai API cho một môi trường trước khi có thể truy cập API đó trong thời gian chạy. Theo mặc định, các tổ chức Apigee được cung cấp 2 môi trường: "thử nghiệm" và "sản phẩm". Môi trường "kiểm thử" thường dùng để triển khai các API đang trong quá trình kiểm thử. Môi trường "prod" thường được dùng để triển khai các API cho mục đích sản xuất. |
| mô hình thuế kết hợp | Một mô hình thuế trong đó nhà cung cấp API đóng vai trò là người đại diện được công bố của nhà phát triển. Tuy nhiên, nhà cung cấp API thay mặt nhà phát triển thanh toán thuế bán hàng thu được từ người đăng ký cho cơ quan thuế địa phương. |
| giới hạn ngầm định | Giới hạn (chẳng hạn như hạn mức số dư trả trước dành cho nhà phát triển) do hoạt động kiếm tiền đặt ra. |
| kiếm tiền | Một thành phần của Dịch vụ Apigee dành cho nhà phát triển, mang đến một cách dễ sử dụng và linh hoạt để kiếm tiền từ các sản phẩm API. |
| mức sử dụng hằng tháng | Tổng mức sử dụng của nhà phát triển trong một tháng cụ thể, bao gồm phí thiết lập + phí giao dịch + phí định kỳ. |
| thanh toán hằng tháng | Các khoản thanh toán định kỳ do nhà phát triển thực hiện dựa trên gói đã mua. Các gói giá có thể có phí định kỳ nhà phát triển thu mỗi tháng bất kể mức sử dụng là gì. |
| tuyên bố ròng | Chứng từ tài chính cho thấy số dư ròng giữa hoá đơn và bảng sao kê chia sẻ doanh thu. |
| mở mức điều chỉnh | Mức điều chỉnh chưa được áp dụng trong tài liệu thanh toán đã công bố. |
| mở tháng thanh toán | Một tháng dương lịch đầy đủ mà chứng từ thanh toán "cuối cùng" chưa được xuất bản. |
| tổ chức | Vùng chứa cho tất cả các đối tượng trong tài khoản Apigee của bạn, bao gồm các API, sản phẩm API, gói API, ứng dụng và nhà phát triển. Mỗi tổ chức mà bạn có thể là thành viên cần phải có tài khoản người dùng. (Hầu hết người dùng sẽ chỉ có tài khoản trong một tổ chức.) Bạn cần cung cấp thông tin đăng nhập (tên người dùng và mật khẩu) và tên tổ chức của mình trong mỗi yêu cầu API mà bạn gửi. |
| danh mục gói | Danh sách các gói API. Mỗi gói sẽ có các sản phẩm API và gói giá tương ứng. |
| số dư trả trước | Số tiền mà nhà phát triển trả trước có thể thanh toán trước cho các gói API. |
| nhà phát triển trả trước | Nhà phát triển thanh toán trước để sử dụng một sản phẩm API. Khi sử dụng sản phẩm API, các khoản tiền sẽ được khấu trừ từ số dư của một nhà phát triển trả trước. Nhà phát triển phải duy trì đủ số dư trả trước để mua sản phẩm API. Nhà phát triển được nhà cung cấp API chỉ định trạng thái trả trước hoặc trả sau. |
| chính sách | Một bước xử lý thực thi dưới dạng một đơn vị logic nguyên tử, có thể sử dụng lại trong luồng API. Các chính sách thông thường bao gồm việc định tuyến các yêu cầu đến điểm cuối phù hợp, chuyển đổi định dạng thông báo, thực thi biện pháp kiểm soát quyền truy cập, gọi dịch vụ từ xa để cung cấp thêm thông tin, che giấu dữ liệu nhạy cảm khỏi người dùng bên ngoài, kiểm tra nội dung thông báo để phát hiện các mối đe doạ tiềm ẩn, lưu các phản hồi thường gặp vào bộ nhớ đệm để cải thiện hiệu suất, v.v. Các chính sách có thể được thực thi có điều kiện dựa trên nội dung hoặc ngữ cảnh của thông báo yêu cầu hoặc phản hồi. Ví dụ: chính sách chuyển đổi có thể được thực thi để tuỳ chỉnh định dạng phản hồi nếu thông báo yêu cầu được gửi từ điện thoại thông minh. |
| nhà phát triển trả sau | Nhà phát triển thanh toán hằng tháng (thông qua hoá đơn) để 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 theo điều khoản thanh toán trong(các) gói có trong hoá đơn. Nhà phát triển được nhà cung cấp API chỉ định trạng thái trả sau hoặc trả trước. |
| điểm giá | Một loạt các mức giá có thể mà bạn có thể tiếp thị sản phẩm. |
| gói giá trên bảng giá | Gói giá mà trong đó nhà phát triển được tính một mức phí cố định hoặc có thể thay đổi cho mỗi giao dịch liên quan đến một sản phẩm API dùng để kiếm tiền. |
| gói giá | Thông tin đặc tả về các khoản phí, khoản phí khác và phần doanh thu chia sẻ khi sử dụng các sản phẩm API được cung cấp trong gói API có thể kiếm tiền. |
| đường dẫn tài nguyên |
Khái niệm RESTful, đường dẫn tài nguyên là một tài nguyên đồng nhất được xác định (URI) giúp xác định đường dẫn mạng đến một tài nguyên nhất định. |
| gói tỷ lệ chia sẻ doanh thu | Gói giá trong đó một tỷ lệ phần trăm doanh thu được tạo ra từ mỗi giao dịch liên quan đến sản phẩm API có thể kiếm tiền sẽ được chia sẻ với nhà phát triển của ứng dụng đưa ra yêu cầu. |
| phần chia sẻ doanh thu và gói giá | Gói giá trong đó một tỷ lệ phần trăm doanh thu được tạo ra từ mỗi giao dịch liên quan đến sản phẩm API có thể kiếm tiền sẽ được chia sẻ với nhà phát triển của ứng dụng đưa ra yêu cầu. Nhà phát triển cũng trả một khoản phí cố định hoặc phí thay đổi cho mỗi giao dịch. |
| hoá đơn tự thanh toán | Chứng từ tài chính được tạo thay vì báo cáo chia sẻ doanh thu. Hoá đơn này nêu chi tiết số tiền phải thanh toán cho nhà phát triển, đồng thời đóng vai trò là hoá đơn cho Nhà cung cấp API thay mặt cho nhà phát triển. |
| gói giá tiêu chuẩn | Một gói giá mà tất cả nhà phát triển đều có thể mua. |
| tax | Tổng thuế áp dụng cho mức sử dụng và phí của nhà phát triển. |
| nạp tiền | Hành động mà nhà phát triển trả trước thực hiện để nạp tiền vào số dư trả trước. |
| chính sách ghi lại giao dịch | Một cơ chế cho phép hoạt động kiếm tiền thu thập các thông số giao dịch và thuộc tính tuỳ chỉnh. Tính năng kiếm tiền cần thông tin này để xử lý hoạt động kiếm tiền, chẳng hạn như việc áp dụng các gói giá cho các yêu cầu và phản hồi API dựa trên các thuộc tính tuỳ chỉnh được ghi nhận trong mỗi giao dịch. |
| nhân viên hỗ trợ chưa công bố | Là một tổ chức (hoặc nhà vận hành) tham gia cung cấp cơ bản ứng dụng, sao cho tổ chức đó được coi là thay mặt nhà phát triển mua nội dung (chỉ nhằm mục đích thuế). Là một nhân viên hỗ trợ không được tiết lộ, tổ chức (hoặc nhà điều hành) có thể thu và tính đến các khoản thuế phải trả của người dùng cuối. Trạng thái này chỉ liên quan đến mục đích về thuế. Trạng thái pháp lý của nhà phát triển trong chuỗi cung ứng sẽ không bị ảnh hưởng. |
| mô hình thuế chưa công bố | Đây là mô hình thuế mà trong đó nhà cung cấp API khấu trừ thuế thu được từ người dùng cuối và thanh toán cho cơ quan thuế địa phương. |
| phiên bản | Phiên bản của giao diện API dành cho nhà phát triển. Ví dụ: pivotaltracker.com/services/v3 hoặc api.enterprise.apigee.com/v1. (Thuật ngữ này được phân biệt với "sửa đổi" (revision) là gói cấu hình và chính sách được đánh số và được kiểm soát theo phiên bản được đóng gói trong một Proxy API. Tóm lại, giao diện API có nhiều phiên bản, trong khi Proxy API có bản sửa đổi. |