Basic terminology

Giao diện lập trình ứng dụng – một loại giao diện giúp một ứng dụng dễ dàng sử dụng các tính năng hoặc dữ liệu từ một ứng dụng khác.

Bằng cách xác định các điểm truy cập ổn định và được đơn giản hoá cho 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 xây dựng. Trong trường hợp là API web, logic và dữ liệu đó sẽ 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 các API cũng ngụ ý một hợp đồng. Hợp đồng này cung cấp một mức độ đảm bảo nào đó mà theo thời gian, API sẽ thay đổi theo cách có thể dự đoán được.

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

Một thành phần tượng trưng 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 nhóm 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 các proxy API trên máy trong một trình chỉnh sửa văn bản hoặc IDE.

Mặt tiền do một 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ợ, giúp nhà phát triển tránh được việc thay đổi mã và cho phép đổi mới ở mọi nơi mà không ảnh hưởng đến các nhóm phát triển nội bộ của bạn. Khi các nhóm phát triển thực hiện thay đổi trong phần phụ trợ, các 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 có thể tuỳ chỉnh chữ ký của một API để đáp ứng đồng thời nhu cầu của nhiều nhóm nhà phát triển.

API được xác định bởi địa chỉ mạng và URI. API được tạo thành từ một đường dẫn cơ sở và một tập hợp các tài nguyên API. Mỗi proxy API xác định một đường dẫn cơ sở và nhiều đường dẫn tài nguyên API (không bắt buộc). Bạn có thể coi API 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ả. 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 các API.

Một tập hợp các 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 các nhà phát triển ứng dụng tại thời điểm thiết kế. Các sản phẩm API có thể được đóng gói thành các gói API để kiếm tiền.

Một khoá API được liên kết với một hoặc nhiều sản phẩm API, thực thi mối 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 application (ứng dụng). Thuật ngữ ứng dụng dùng để chỉ những ứng dụng dành cho thiết bị di động sử dụng API. Các nhà phát triển triển khai ứng dụng bằng nhiều ngôn ngữ lập trình và sử dụng nhiều công nghệ và nền tảng. Các nhà phát triển muốn sử dụng các API đăng ký ứng dụng trong tổ chức của một nhà cung cấp API đang dùng Apigee Edge.

Sau khi đăng ký ứng dụng, Apigee sẽ tạo một khoá và mã thông báo bí mật cho API để nhận dạng ứng dụng. Nhà phát triển sẽ 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 phương thức 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 API mà proxy hiển thị có thể truy cập được qua mạng. Theo mặc định, các tổ chức được cung cấp 2 môi trường: kiểm thử và sản phẩm.

• 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 dùng để quảng bá các proxy API từ môi trường kiểm thử sau khi các proxy đó đã được phát triển và kiểm thử đầy đủ.

Vùng chứa 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.

Cần có tài khoản người dùng cho mỗi 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ử và có thể sử dụng lại trong quy trình xử lý proxy API.

Chức năng dựa trên chính sách điển hình bao gồm 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 để biết thêm thông tin, che 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 yêu cầu hoặc thông báo 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.

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