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
Tổ chức là vùng chứa cấp cao nhất trong Apigee Edge. Thư mục này chứa tất cả các proxy API và tài nguyên liên quan. Mặc dù phần còn lại của chủ đề này sẽ đi sâu hơn về các tổ chức, nhưng sau đây là một số điểm thực tế:
- Theo mặc định, tên tổ chức của bạn nằm trong URL dùng để gọi các proxy API, như mô tả trong phần Giới thiệu về máy chủ ảo.
Ví dụ:
http(s)://your_org_name-environment.apigee.net/proxy_base_path/...
- Tên tổ chức của bạn nằm trong URL của giao diện người dùng quản lý Edge. Ví dụ: URL sau đây hiển thị các proxy API cho tổ chức
docs:
- Mặc dù chỉ tạo một tổ chức, nhưng bạn có thể thuộc về các tổ chức khác với tư cách là người dùng hoặc quản trị viên có các quyền cụ thể. Trong giao diện người dùng quản lý Edge, nếu thuộc nhiều tổ chức, bạn có thể chuyển sang một tổ chức khác như mô tả trong phần Chuyển đổi giữa các tổ chức.
- Khi bạn thực hiện các lệnh gọi bằng API quản lý với tư cách là người dùng có vai trò Quản trị viên tổ chức, tổ chức là một phần bắt buộc của đường dẫn trong hầu hết các lệnh gọi. Ví dụ: yêu cầu cURL API quản lý sau đây sẽ trả về danh sách tất cả các proxy API trong một tổ chức:
curl https://api.enterprise.apigee.com/v1/organizations/your_org_name/apis -u org_admin_email_address
Video: Xem một video ngắn để tìm hiểu cách các tổ chức hỗ trợ cấu trúc nhiều đối tượng thuê để quản lý API.
Thành phần tổ chức
Khi bạn tạo tài khoản Edge, Edge sẽ tự động tạo một tổ chức cho bạn. Sau khi tạo, bạn có thể thêm người dùng vào tổ chức, tạo các sản phẩm API và proxy API, cũng như đăng ký nhà phát triển và ứng dụng.
Hình ảnh sau đây minh hoạ các thành phần chính của mô hình tổ chức Edge. Mô hình này xác định mối quan hệ giữa các API, sản phẩm API, ứng dụng và nhà phát triển ứng dụng trong Edge.
Mô hình này không thể hiện tất cả các tính năng của Apigee Edge. Nếu bạn sử dụng tính năng kiếm tiền, thì mô hình sẽ có thêm các thành phần. Để biết thêm thông tin, hãy xem bài viết Tổng quan về việc kiếm tiền. Xem phần Quản lý công ty và nhà phát triển để biết thông tin về cách quản lý công ty và nhà phát triển có hoạt động kiếm tiền.
Tên tổ chức
Tên của tổ chức là:
- Tổ chức đánh giá:
username-eval - Tổ chức có tính phí: Do người dùng xác định tại thời điểm cung cấp ban đầu
Sau khi tạo, bạn không thể đổi tên tổ chức.
Tên tổ chức sẽ trở thành một phần của URL đến các proxy API và một phần của URL khi đưa ra yêu cầu đến API quản lý Edge. Ví dụ: một URL thông thường được dùng để truy cập vào một proxy API có dạng:
http://org-name-env.apigee.net/v1/weather/forecastrss
trong đó:
- org-name là tên tổ chức của bạn.
- env là môi trường triển khai của proxy API, có thể là môi trường kiểm thử hoặc môi trường sản xuất.
Ví dụ:
http://myorg-test.apigee.net/v1/weather/forecastrss
Thành phần tổ chức
Bảng sau đây mô tả chi tiết hơn về các thành phần của mô hình tổ chức:
| Thành phần | Mô tả |
|---|---|
|
Tổ chức |
Mỗi tài khoản Apigee đều liên kết với một hoặc nhiều tổ chức trên Apigee Edge. Tổ chức này chứa thông tin về tất cả các thành phần, bao gồm cả proxy API, sản phẩm API, gói API, ứng dụng và nhà phát triển. Chủ tài khoản không bị giới hạn ở một tổ chức duy nhất. Một số chủ tài khoản có thể xác định hoặc là thành viên của nhiều tổ chức hỗ trợ các cộng đồng nhà phát triển ứng dụng khác nhau. |
| Môi trường | Ngữ cảnh thực thi thời gian chạy cho các proxy API trong một tổ chức. Hãy xem phần bên dưới để biết thêm thông tin về các môi trường. |
|
Người dùng |
Trong một tổ chức, nơi người tạo tài khoản tự động là quản trị viên, bạn có thể tạo thêm người dùng. Người dùng tạo thành nhóm API của tổ chức, có thể bao gồm những người như quản trị viên, người tạo sản phẩm API và proxy API, người dùng giám sát số liệu phân tích và các số liệu thống kê khác, cũng như những người khác. Mỗi người dùng có thể có vai trò và đặc quyền truy cập riêng. Ví dụ: xác định một số người dùng là Quản trị viên tổ chức và Quản trị viên hoạt động có đặc quyền sửa đổi tổ chức và các thành phần của tổ chức. Xác định những người dùng khác có quyền tạo các proxy API và sản phẩm API, nhưng không có đặc quyền sửa đổi những người dùng khác. Người dùng có thể là thành viên của nhiều tổ chức. Ví dụ: công ty của bạn có thể xác định nhiều tổ chức trên Apigee Edge để hỗ trợ các cộng đồng nhà phát triển khác nhau. Tuy nhiên, về nội bộ, cùng một nhóm người sẽ tạo tất cả các proxy API và sản phẩm API, do đó, họ là thành viên của tất cả các tổ chức của bạn. Bạn không cần tạo tài khoản Apigee (tức là tạo một tổ chức Apigee) để trở thành người dùng. Quản trị viên có thể thêm bạn vào một tổ chức hiện có. Tất cả người dùng đều đăng nhập vào Apigee Edge tại đây: https://enterprise.apigee.com. |
|
API proxy |
Người dùng trong một tổ chức tạo một hoặc nhiều proxy API. Một proxy API xác định mối liên kết giữa một điểm cuối HTTP có sẵn công khai với một dịch vụ phụ trợ. Bạn cũng có thể định cấu hình các proxy API để bao gồm tính năng bảo mật (chẳng hạn như OAuth), thực hiện chuyển đổi thông báo (chẳng hạn như XML sang JSON), giới hạn lưu lượng truy cập vào các dịch vụ phụ trợ và thực hiện các thao tác có giá trị khác trên yêu cầu, phản hồi và bằng các lệnh gọi dịch vụ. Edge thu thập dữ liệu để phân tích về các proxy API. |
|
Sản phẩm API |
Người dùng trong một tổ chức tạo một hoặc nhiều sản phẩm API, trong đó sản phẩm API là một gói gồm các proxy API kết hợp với một gói dịch vụ. Gói dịch vụ đó có thể đặt giới hạn truy cập đối với các proxy API, cung cấp tính năng bảo mật, cho phép giám sát và phân tích, đồng thời cung cấp các tính năng bổ sung. Edge thu thập dữ liệu để phân tích về các sản phẩm API. |
|
Nhà phát triển |
Một tổ chức có một hoặc nhiều nhà phát triển xây dựng các ứng dụng sử dụng các API (được tập hợp thành các sản phẩm API) do tổ chức của bạn xác định. Nhà phát triển sử dụng API nhưng không thể tạo API hoặc thực hiện bất kỳ hành động nào khác trong tổ chức. Nhà phát triển có thể là người trong công ty, đối tác hoặc nhà phát triển bên ngoài trả tiền để truy cập vào API của bạn. Nhà phát triển phải được đăng ký trong tổ chức của bạn thì mới có thể đăng ký một ứng dụng và nhận khoá API để truy cập vào các API của bạn. Là một nhà cung cấp API, bạn có quyền quyết định cách thêm, cập nhật hoặc xoá nhà phát triển trong tổ chức của mình. Bạn có thể thêm các ứng dụng này theo cách thủ công thông qua giao diện người dùng quản lý Edge, tạo một cổng thông tin cho nhà phát triển để đăng ký các ứng dụng này thông qua một trang web hoặc xác định cơ chế đăng ký của riêng bạn bằng cách sử dụng API quản lý Edge. Nhà phát triển không bắt buộc phải có tài khoản trên Edge và hầu hết nhà phát triển sẽ không cần biết bất cứ điều gì về Edge. Nếu nhà phát triển có tài khoản trên Edge, thì thường là với tư cách người dùng trong một tổ chức khác hoặc để sử dụng Dịch vụ API Edge. |
|
Ứng dụng |
Nhà phát triển tạo một hoặc nhiều ứng dụng khách sử dụng API của bạn. Nhà phát triển phải đăng ký ứng dụng của họ với tổ chức của bạn. Ứng dụng trong Edge là một bản trình bày về ứng dụng thực tế của nhà phát triển, cung cấp cho nhà phát triển một khoá API để truyền vào cùng với mọi yêu cầu đến API của bạn. Vì tất cả ứng dụng đều được đăng ký trong tổ chức của bạn, nên bạn có thể dùng Edge để giám sát và thu thập thông tin phân tích về ứng dụng cũng như việc ứng dụng sử dụng các API của bạn. |
|
Khoá API/Mã thông báo OAuth |
Tuỳ thuộc vào cơ chế uỷ quyền mà bạn xác định cho các API của mình, ứng dụng sẽ truyền một khoá API cùng với mọi yêu cầu đến các API của bạn. Nếu khoá đó hợp lệ, yêu cầu sẽ được cho phép. Edge hỗ trợ nhiều loại xác thực, chẳng hạn như khoá API đơn giản, OAuth hai bên, OAuth ba bên và các loại khác. Là một nhà cung cấp API, bạn phải xác định cách để nhà phát triển đăng ký ứng dụng của họ. Bằng cách đăng ký ứng dụng, bạn sẽ trả lại cho nhà phát triển khoá cần thiết để truy cập vào các API của bạn. Tại thời điểm đăng ký ứng dụng, nhà phát triển có thể chọn truy cập vào một sản phẩm API hoặc nhiều sản phẩm API. Ứng dụng thực tế của nhà phát triển sử dụng cùng một khoá để truy cập vào tất cả các sản phẩm API được liên kết với ứng dụng (phần trình bày đã đăng ký của ứng dụng nhà phát triển trong Edge). Bất cứ lúc nào, bạn cũng có thể thu hồi khoá để ứng dụng của nhà phát triển không còn quyền truy cập vào các API của bạn (mặc dù bản trình bày đã đăng ký của ứng dụng đó vẫn tồn tại trong tổ chức của bạn). Hoặc bạn có thể xác định giới hạn thời gian cho một khoá để nhà phát triển phải làm mới khoá sau một khoảng thời gian cụ thể. |
Giới thiệu về môi trường
Môi trường là một bối cảnh thực thi thời gian chạy cho các proxy API trong một tổ chức. Bạn phải triển khai một proxy API vào một môi trường thì mới có thể truy cập vào proxy đó. Bạn có thể triển khai một proxy API cho một hoặc nhiều môi trường.
Một tổ chức có thể chứa nhiều môi trường. Ví dụ: bạn có thể xác định môi trường dev, test và prod trong một tổ chức.
Tổ chức cung cấp phạm vi cho một số chức năng của Apigee. Ví dụ: bạn có thể cung cấp dữ liệu bản đồ khoá-giá trị (KVM) ở cấp tổ chức, tức là các API Proxy được triển khai cho mọi môi trường sẽ nhận được cùng một dữ liệu từ KVM. Một số chức năng, chẳng hạn như lưu vào bộ nhớ đệm, có thể được giới hạn phạm vi cho tổ chức hoặc cho một môi trường cụ thể trong tổ chức. Dữ liệu phân tích Apigee được phân vùng theo sự kết hợp giữa tổ chức và môi trường.
Dưới đây là các thực thể chính mà bạn quản lý trong một tổ chức, bao gồm cả những thực thể được xác định trên toàn cầu trong tổ chức và những thực thể được xác định cụ thể cho một môi trường:
