Tổng quan về việc xuất bản

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

Xuất bản là quy trình cung cấp API của bạn cho nhà phát triển ứng dụng sử dụng.

Video: Video sau đây giới thiệu tổng quan về hoạt động xuất bản bằng API.

API Phát hành bao gồm các nhiệm vụ sau, được mô tả trong chủ đề này:

  1. Tạo các sản phẩm API trên Edge để nhóm các API của bạn.
  2. Đăng ký nhà phát triển ứng dụng trên Edge.
  3. Đăng ký ứng dụng nhà phát triển trên Edge.
  4. Cung cấp tài liệu và sự hỗ trợ của cộng đồng cho các API của bạn.

Tác vụ 1: Tạo một sản phẩm API trên Edge

Nhiệm vụ đầu tiên trong quy trình xuất bản là tạo một sản phẩm API. Sản phẩm API là một tập hợp các tài nguyên API được cung cấp dưới dạng một gói cho nhà phát triển ứng dụng sử dụng. Tạo sản phẩm API bằng Edge Management API hoặc giao diện người dùng. (Xem bài viết Sản phẩm API là gì? để tìm hiểu thêm về các sản phẩm API.)

Sơ đồ trình tự từ trái sang phải cho thấy nhà phát triển, ứng dụng, API và dịch vụ phụ trợ. Biểu tượng và tài nguyên API được làm nổi bật. Một đường chấm chấm chỉ từ nhà phát triển đến biểu tượng của một ứng dụng mà nhà phát triển đã tạo. Các mũi tên đi và về từ ứng dụng cho thấy quy trình yêu cầu và phản hồi đối với biểu tượng API, với khoá ứng dụng nằm phía trên yêu cầu. Biểu tượng và tài nguyên API được làm nổi bật. Bên dưới biểu tượng API là 2 nhóm đường dẫn tài nguyên được nhóm thành 2 sản phẩm API: Sản phẩm vị trí và Sản phẩm đa phương tiện. Sản phẩm Vị trí có các tài nguyên cho /countries, /cities và /languages, còn sản phẩm Nội dung nghe nhìn có các tài nguyên cho /books, /magazines và /movies. Ở bên phải API là các tài nguyên phụ trợ mà API đang gọi, bao gồm cơ sở dữ liệu, bus dịch vụ doanh nghiệp, máy chủ ứng dụng và một phụ trợ chung.

Trong hình này, API bao gồm 2 sản phẩm, mỗi sản phẩm chứa 3 tài nguyên API.

Là nhà cung cấp API, bạn chịu trách nhiệm xây dựng các API và sản phẩm API để xử lý quyền kiểm soát truy cập, hạn chế sử dụng và mọi yêu cầu kinh doanh khác. Ví dụ: bạn có thể:

  • Phát hành một sản phẩm API miễn phí cho phép quyền chỉ đọc đối với các tài nguyên API của sản phẩm đó.
  • Phát hành một sản phẩm API thứ hai với mức giá thấp, cho phép truy cập đọc/ghi vào cùng các tài nguyên API như phiên bản miễn phí nhưng có giới hạn truy cập thấp, chẳng hạn như 1.000 yêu cầu mỗi ngày.
  • Phát hành sản phẩm API thứ ba với mức giá cao hơn, cho phép truy cập đọc/ghi vào cùng một tài nguyên API nhưng có giới hạn truy cập cao.

Điều quan trọng cần nhớ là Edge mang đến cho bạn sự linh hoạt để tạo các sản phẩm API phù hợp với yêu cầu kinh doanh của API.

Để biết thêm thông tin về cách tạo sản phẩm API, hãy xem phần Tạo sản phẩm API.

Tác vụ 2: Đăng ký nhà phát triển ứng dụng trên Edge

Nhà phát triển tạo ra các ứng dụng sử dụng API của bạn. Nhà phát triển ứng dụng đăng ký trên Apigee Edge trước khi họ có thể đăng ký ứng dụng của mình. Khi đăng ký ứng dụng, họ sẽ nhận được một khoá API cho phép ứng dụng truy cập vào API.

Thông qua quy trình đăng ký ứng dụng, bạn có thể kiểm soát những người có quyền truy cập vào API của mình. Bất cứ lúc nào, bạn cũng có thể xoá một nhà phát triển ứng dụng. Thao tác này sẽ vô hiệu hoá tất cả khoá API liên kết với nhà phát triển đó, do đó từ chối quyền truy cập của nhà phát triển đó vào các API của bạn.

Sơ đồ trình tự từ trái sang phải cho thấy nhà phát triển, ứng dụng, API và dịch vụ phụ trợ. Biểu tượng nhà phát triển được làm nổi bật. Một đường chấm chấm nối từ nhà phát triển được đánh dấu đến biểu tượng của một ứng dụng mà nhà phát triển đó đã tạo. Các mũi tên đi và về từ ứng dụng cho thấy quy trình yêu cầu và phản hồi đối với biểu tượng API, với khoá ứng dụng nằm phía trên yêu cầu. Bên dưới biểu tượng API là 2 nhóm đường dẫn tài nguyên được nhóm thành 2 sản phẩm API: Sản phẩm vị trí và Sản phẩm đa phương tiện. Sản phẩm Vị trí có các tài nguyên cho /countries, /cities và /languages, còn sản phẩm Nội dung nghe nhìn có các tài nguyên cho /books, /magazines và /movies. Ở bên phải API là các tài nguyên phụ trợ mà API đang gọi, bao gồm cơ sở dữ liệu, bus dịch vụ doanh nghiệp, máy chủ ứng dụng và một phụ trợ chung.

Là nhà cung cấp API, bạn quyết định cách đăng ký nhà phát triển. Ví dụ: bạn có thể sử dụng quy trình đăng ký thủ công, trong đó yêu cầu nhà phát triển tiềm năng liên hệ với tổ chức của bạn để đăng ký. Nhà phát triển tiềm năng phải cung cấp tất cả thông tin cần thiết, chẳng hạn như địa chỉ email, họ tên và tên công ty. Nếu phê duyệt yêu cầu của nhà phát triển, bạn có thể sử dụng giao diện người dùng quản lý Edge để đăng ký nhà phát triển theo cách thủ công. Xem bài viết Quản lý nhà phát triển ứng dụng để biết thêm thông tin.

Apigee cũng cung cấp các công cụ mà bạn có thể dùng để tự động hoá quy trình đăng ký nhà phát triển. Ví dụ:

  • Sử dụng API quản lý Apigee Edge để tích hợp chức năng đăng ký vào trang web hiện có của bạn. API quản lý Edge là một API REST mà bạn có thể dùng để thực hiện mọi khía cạnh của quy trình đăng ký nhà phát triển. Hãy xem phần Sử dụng API quản lý Edge để xuất bản API để biết thêm thông tin.
  • Sử dụng cổng Apigee Developer Services để đăng ký nhà phát triển. Cổng thông tin này có hỗ trợ tích hợp sẵn cho việc đăng ký nhà phát triển, nhưng cũng có nhiều tính năng khác để hỗ trợ các API của bạn. Hãy xem bài viết Cổng thông tin dành cho nhà phát triển là gì? để biết thêm thông tin.

Tác vụ 3: Đăng ký ứng dụng dành cho nhà phát triển trên Edge

Trước khi có thể truy cập vào các API của bạn, ứng dụng phải được đăng ký trên Edge. Tuy nhiên, chỉ nhà phát triển đã đăng ký mới có thể đăng ký ứng dụng trên Edge.

Sơ đồ trình tự từ trái sang phải cho thấy nhà phát triển, ứng dụng, API và dịch vụ phụ trợ. Các mũi tên ứng dụng, yêu cầu/phản hồi và khoá API được làm nổi bật. Một đường chấm chấm chỉ từ nhà phát triển đến biểu tượng của một ứng dụng mà nhà phát triển đã tạo. Các mũi tên đi và về từ ứng dụng cho thấy quy trình yêu cầu và phản hồi đối với biểu tượng API, với khoá ứng dụng nằm phía trên yêu cầu. Biểu tượng và tài nguyên API được làm nổi bật. Bên dưới biểu tượng API là 2 nhóm đường dẫn tài nguyên được nhóm thành 2 sản phẩm API: Sản phẩm vị trí và Sản phẩm đa phương tiện. Sản phẩm Vị trí có các tài nguyên cho /countries, /cities và /languages, còn sản phẩm Nội dung nghe nhìn có các tài nguyên cho /books, /magazines và /movies. Ở bên phải API là các tài nguyên phụ trợ mà API đang gọi, bao gồm cơ sở dữ liệu, bus dịch vụ doanh nghiệp, máy chủ ứng dụng và một phụ trợ chung.

Tại thời điểm đăng ký ứng dụng, nhà phát triển sẽ chọn một hoặc nhiều sản phẩm API. Ví dụ: bạn có thể xuất bản nhiều sản phẩm API tương ứng với các loại dịch vụ và gói định giá khác nhau. Sau đó, nhà phát triển ứng dụng có thể chọn trong danh sách các sản phẩm API có sẵn.

Để phản hồi việc đăng ký ứng dụng trên Edge, Edge sẽ chỉ định một khoá API duy nhất cho ứng dụng. Ứng dụng phải truyền khoá API đó trong mỗi yêu cầu đến một tài nguyên API. Khoá được xác thực và nếu hợp lệ, yêu cầu sẽ được cấp. Bất cứ lúc nào, bạn (nhà cung cấp dịch vụ) đều có thể thu hồi khoá để ứng dụng không thể truy cập vào các API của bạn nữa.

Là nhà cung cấp API, bạn quyết định cách bạn muốn đăng ký ứng dụng. Bạn có thể:

  • Sử dụng quy trình thủ công yêu cầu nhà phát triển liên hệ với tổ chức của bạn để đăng ký ứng dụng của họ. Để phản hồi, bạn sẽ gửi khoá API cho nhà phát triển, có thể là qua email.
  • Sử dụng Edge Management API để tích hợp chức năng đăng ký ứng dụng và phân phối khoá vào trang web của bạn.
  • Đối với tài khoản Edge có tính phí, hãy sử dụng cổng Apigee Developer Services có hỗ trợ sẵn cho việc đăng ký ứng dụng và phân phối khoá API.

Để biết thêm thông tin, hãy xem bài viết Đăng ký ứng dụng và quản lý khoá API.

Nhiệm vụ 4: Lập tài liệu cho API

Một điểm quan trọng cần cân nhắc đối với các sản phẩm API phát hành là cung cấp tài liệu và cơ chế phản hồi của nhà phát triển. Các cổng thông tin dành cho nhà phát triển có tính năng xuất bản trên mạng xã hội ngày càng được sử dụng nhiều hơn để liên lạc với cộng đồng phát triển. Điều này bao gồm việc truyền đạt nội dung tĩnh (chẳng hạn như tài liệu về API và điều khoản sử dụng), cũng như nội dung động do cộng đồng đóng góp (chẳng hạn như blog và diễn đàn), cũng như các tính năng hỗ trợ khách hàng.

Sơ đồ trình tự từ trái sang phải cho thấy nhà phát triển, ứng dụng, API và dịch vụ phụ trợ. Biểu tượng nhà phát triển được làm nổi bật. Bên dưới nhà phát triển là một hộp đại diện cho cổng thông tin cho nhà phát triển. Cổng thông tin này chứa tài liệu API, các mẫu, hướng dẫn, tài liệu tham khảo API và những nội dung khác. Cổng thông tin này cũng có các blog, diễn đàn và cổng thông tin hỗ trợ. Một đường chấm chấm nối từ nhà phát triển được làm nổi bật đến biểu tượng của một ứng dụng mà nhà phát triển đó đã tạo. Các mũi tên đi và về từ ứng dụng cho thấy quy trình yêu cầu và phản hồi đến một biểu tượng API, với khoá ứng dụng nằm phía trên yêu cầu. Bên dưới biểu tượng API là 2 nhóm đường dẫn tài nguyên được nhóm thành 2 sản phẩm API: Sản phẩm vị trí và Sản phẩm đa phương tiện. Sản phẩm Vị trí có các tài nguyên cho /countries, /cities và /languages, còn sản phẩm Nội dung nghe nhìn có các tài nguyên cho /books, /magazines và /movies. Ở bên phải API là các tài nguyên phụ trợ mà API đang gọi, bao gồm cơ sở dữ liệu, bus dịch vụ doanh nghiệp, máy chủ ứng dụng và một phụ trợ chung.

Bạn có thể tự tạo trang web để triển khai tài liệu hoặc nếu có tài khoản Edge trả phí, bạn có thể sử dụng cổng Apigee Developer Services. Cổng thông tin này có sẵn các tài liệu hỗ trợ, blog, diễn đàn và các loại nội dung khác cần thiết để hỗ trợ cộng đồng nhà phát triển của bạn.

SmartDocs cho phép bạn ghi lại API trên cổng Dịch vụ dành cho nhà phát triển theo cách giúp tài liệu API hoàn toàn có tính tương tác. Tài liệu tương tác với SmartDocs có nghĩa là người dùng cổng thông tin có thể:

  • Đọc về API
  • Gửi yêu cầu trực tiếp đến API
  • Xem phản hồi trực tiếp do API trả về

Ví dụ: hình sau đây cho thấy một API được ghi lại trên cổng thông tin bằng cách sử dụng SmartDocs. API này cung cấp thông tin thời tiết cho một vị trí cụ thể:

Một chủ đề về phương thức API SmartDocs cho phép bạn gọi một API thời tiết bằng cách nhấp vào một nút trong chủ đề.

Nhà phát triển nhập một giá trị cho tham số truy vấn "w" để chỉ định vị trí, sau đó nhấp vào nút Gửi yêu cầu để xem yêu cầu và phản hồi trực tiếp. Bằng cách tạo tài liệu tương tác về các API của mình, bạn giúp người dùng cổng thông tin dễ dàng tìm hiểu, kiểm thử và đánh giá các API của bạn.

API quản lý Edge là một API REST cho phép bạn truy cập vào Các dịch vụ API bằng bất kỳ ứng dụng HTTP nào. Apigee sử dụng SmartDocs để tạo tài liệu tương tác cho API quản lý Edge. Xem tài liệu về API đó tại đây.

Để biết thêm thông tin, hãy xem bài viết Sử dụng SmartDocs để ghi lại API.