Basic terminology

Giao diện lập trình ứng dụng (application programming interface – API) – một giao diện giúp một ứng dụng dễ dàng sử dụng các chức năng hoặc dữ liệu của một ứng dụng khác.

Bằng cách xác định các điểm truy cập ổn định, đơn giản hoá vào logic và dữ liệu ứng dụng, API cho phép nhà phát triển dễ dàng truy cập và sử dụng lại logic ứng dụng do các nhà phát triển khác tạo. Trong trường hợp API web, logic và dữ liệu đó được hiển thị qua mạng. Vì các ứng dụng sử dụng API rất nhạy cảm với các thay đổi, nên API cũng ngụ ý một hợp đồng. Hợp đồng cung cấp một mức độ đảm bảo rằng theo thời gian, API sẽ thay đổi theo cách có thể dự đoán.

Apigee cung cấp nhiều thông tin về API và các phương pháp hay nhất để phát triển cũng như sử dụng API. Để bắt đầu, hãy xem buổi phát trực tiếp về Thiết kế API hoặc tải cuốn sách điện tử miễn phí Thiết kế API web: Các phương pháp hay nhất để tạo giao diện mà nhà phát triển yêu thích.

Một mặt tiền trên Edge cho một hoặc nhiều API, dịch vụ HTTP chung hoặc ứng dụng (chẳng hạn như Node.js).

Proxy API được triển khai dưới dạng một tập hợp các tệp cấu hình, chính sách và mã dựa trên một tập hợp tài nguyên do Apigee Edge cung cấp. Bạn có thể tạo và định cấu hình proxy API bằng giao diện người dùng quản lý Apigee Edge hoặc triển khai proxy API cục bộ trong trình chỉnh sửa văn bản hoặc IDE.

Mặt tiền do proxy API cung cấp sẽ tách API dành cho nhà phát triển khỏi các dịch vụ phần phụ trợ, bảo vệ nhà phát triển khỏi các thay đổi mã và cho phép đổi mới ở cấp độ cao mà không ảnh hưởng đến các nhóm phát triển nội bộ. Khi các nhóm phát triển thực hiện các thay đổi về phần phụ trợ, nhà phát triển sẽ tiếp tục gọi cùng một giao diện mà không bị gián đoạ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 tuỳ chỉnh chữ ký của API để đáp ứng nhu cầu của nhiều nhà phát triển cùng một lúc.

API được xác định bằng địa chỉ mạng và URI. API bao gồm một đường dẫn cơ sở và một tập hợp tài nguyên API. Mỗi proxy API xác định một đường dẫn cơ sở và tuỳ ý là nhiều đường dẫn tài nguyên API. Bạn có thể coi API chỉ là một tập hợp các URI, tất cả đều có chung một đường dẫn cơ sở.

Để giúp bạn dễ dàng quản lý các API, Apigee bổ sung tên hiển thị và nội dung mô tả cho các URI thô này. Edge cho phép bạn đính kèm chính sách và mã vào URI, cho phép kiểm soát và quản lý chi tiết hành vi của API.

Một tập hợp tài nguyên API (URI) kết hợp với hạn mức hoặc gói dịch vụ được phát hành cho nhà phát triển ứng dụng tại thời điểm thiết kế. Sau đó, các sản phẩm API có thể được đóng gói vào các gói API để kiếm tiền.

Khoá API được liên kết với một hoặc nhiều sản phẩm API, thực thi liên kết giữa một ứng dụng và gói URI mà ứng dụng được phép sử dụng.

Từ viết tắt của ứng dụng. Thuật ngữ ứng dụng dùng để chỉ các ứng dụng di động sử dụng API. Nhà phát triển triển khai ứng dụng bằng nhiều ngôn ngữ lập trình, đồng thời sử dụng nhiều công nghệ và nền tảng. Những nhà phát triển muốn sử dụng API sẽ đăng ký ứng dụng trong tổ chức của nhà cung cấp API trên Apigee Edge.

Khi ứng dụng được đăng ký, Apigee sẽ tạo một khoá API và khoá bí mật để xác định ứng dụng. Nhà phát triển nhúng khoá API vào ứng dụng để hiển thị khoá đó khi đưa ra yêu cầu. Dịch vụ API triển khai tính năng bảo mật xung quanh khoá API thông qua quy trình xác thực khoá API trực tiếp hoặc thông qua OAuth.

Ngữ cảnh thực thi thời gian chạy cho proxy API. Bạn phải triển khai proxy API cho một môi trường trước khi có thể truy cập vào API mà proxy API đó hiển thị qua mạng. Theo mặc định, các tổ chức được cấp phép hai môi trường: test và prod.

• Môi trường kiểm thử thường được dùng để triển khai proxy API trong quá trình phát triển.
• Môi trường prod thường được dùng để quảng bá proxy API từ môi trường kiểm thử sau khi các proxy này đã được phát triển và kiểm thử đầy đủ.

Một vùng chứa cho tất cả các đối tượng trong tài khoản Apigee Edge, bao gồm cả proxy API, sản phẩm API, gói API, ứng dụng và nhà phát triển.

Bạn cần có tài khoản người dùng cho từng tổ chức mà bạn là thành viên. (Hầu hết người dùng sẽ chỉ có một tài khoản trong một tổ chức.)

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 quy trình xử lý proxy API.

Chức năng thông thường dựa trên chính sách bao gồm việc chuyển đổi định dạng thông báo, thực thi kiểm soát quyền truy cập, gọi các dịch vụ từ xa để biết thêm thông tin, che giấu dữ liệu nhạy cảm của người dùng bên ngoài, kiểm tra nội dung thông báo để tìm các mối đe doạ tiềm ẩn, lưu các phản hồi phổ biến 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 một yêu cầu hoặc thông báo phản hồi. Ví dụ: chính sách biế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.

Phiên bản 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 khác với bản sửa đổi, là gói cấu hình và chính sách được đánh số, được kiểm soát theo phiên bản, được đóng gói vào một Proxy API. Giao diện API có phiên bản; proxy API có bản sửa đổi.