Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến tài liệu về
Apigee X. thông tin
Một tổ chức là vùng chứa cấp cao nhất trong Apigee Edge. Tệp này chứa tất cả proxy API và các tài nguyên liên quan. Mặc dù phần còn lại của chủ đề này sẽ phân tích sâu hơn về 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 sẽ nằm trong URL dùng để gọi 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ù có thể bạn 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 về 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 cuộc gọi bằng API quản lý với tư cách là người dùng trong vai trò Quản trị viên tổ chức, tổ chức là một phần bắt buộc trong đường dẫn của hầu hết các lệnh gọi. Ví dụ: yêu cầu cURL API quản lý sau đây 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 video ngắn để tìm hiểu cách các tổ chức hỗ trợ cấu trúc đa khách hàng để 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 xong, bạn có thể thêm người dùng vào tổ chức của mình, tạo proxy API và các sản phẩm API, cũng như đăng ký cho nhà phát triển và ứng dụng.
Hình ảnh sau đây cho thấy 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 liên hệ giữa các API, sản phẩm API, ứng dụng và nhà phát triển ứng dụng của bạn trong Edge.
Mô hình này không thể hiện tất 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 này sẽ có các thành phần bổ sung. Để biết thêm thông tin, hãy xem bài viết Tổng quan về hoạt động 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ác 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 cấp phép lần đầu
Sau khi tạo, bạn không thể đổi tên một tổ chức.
Tên tổ chức sẽ trở thành một phần của URL tới các proxy API của bạn và là một phần của URL khi gửi yêu cầu đến API Quản lý Edge. Ví dụ: một URL thông thường dùng để truy cập 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 vừa là môi trường thử nghiệm vừa là môi trường thực 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 các thành phần của mô hình tổ chức:
| Thành phần | Nội dung 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 đang sử dụng Apigee Edge. Tổ chức chứa ảnh đại diện cho tất cả các thành phần bao gồm 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ợ nhiều cộng đồng nhà phát triển ứng dụng. |
| Môi trường | Ngữ cảnh thực thi trong 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ề 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 sẽ tạo nên nhóm API của tổ chức, trong đó có thể bao gồm những người như quản trị viên, proxy API và người tạo sản phẩm API, người dùng theo dõi số liệu phân tích và các số liệu thống kê khác, v.v. Mỗi người dùng có thể có vai trò và đặc quyền truy cập khác nhau. 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á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 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 sử dụng Apigee Edge để hỗ trợ nhiều cộng đồng nhà phát triển. Mặc dù vậy, trong nội bộ, cùng một người xây dựng tất cả proxy API và các sản phẩm API, và do đó, sẽ 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 phải tạo tài khoản Apigee (tức là tạo một tổ chức Apigee) để người dùng có thể tiếp tục sử 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. |
|
Proxy API |
Người dùng trong tổ chức tạo một hoặc nhiều proxy API. 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ợ. Các proxy API cũng có thể được định cấu hình để bao gồm tính năng bảo mật (chẳng hạn như OAuth), thực hiện việc chuyển đổi thông báo (chẳng hạn như XML thành 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 đối với yêu cầu, phản hồi và với chú thích dịch vụ. Edge thu thập dữ liệu để phân tích trên các proxy API. |
|
Sản phẩm API |
Người dùng trong 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 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 vào 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, cũng như cung cấp các tính năng bổ sung. Edge thu thập dữ liệu để phân tích trên các sản phẩm API. |
|
Nhà phát triển |
Một tổ chức chứa một hoặc nhiều nhà phát triển xây dựng ứng dụng sử dụng 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à nhà phát triển nội bộ trong công ty của bạn, họ có thể là đối tác hoặc có thể là nhà phát triển bên ngoài trả tiền để truy cập vào các API của bạn. Nhà phát triển phải đăng ký trong tổ chức của bạn thì mới có thể đăng ký ứng dụng và nhận được khoá API để truy cập vào các API của bạn. Là 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 mã 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ý 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 Edge Management API. 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 có tài khoản trên Edge, nhà phát triển thường là 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 các 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à ứ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 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 để theo dõi và thu thập thông tin phân tích về ứng dụng cũng như về việc 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ẽ chuyể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ệ thì 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 cấp quyền truy cập, OAuth cấp quyền truy cập và các phương thức khác. Là nhà cung cấp API, bạn phải xác định cách thức để nhà phát triển đăng ký ứng dụng của họ. Bằng cách đăng ký ứng dụng của họ, bạn 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ả sản phẩm API liên kết với ứng dụng (phiên bản đã đăng ký của ứng dụng của 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 có quyền truy cập vào API của bạn nữa (mặc dù tổ chức của bạn vẫn có đại diện đã đăng ký của ứng dụng của nhà phát triển). Bạn cũng có thể xác định giới hạn thời gian cho khoá để nhà phát triển phải làm mới khoá đó sau một thời gian cụ thể. |
Giới thiệu về môi trường
Môi trường là ngữ cảnh thực thi trong thời gian chạy cho các proxy API trong một tổ chức. Bạn phải triển khai proxy API cho một môi trường thì mới có thể truy cập vào môi trường đó. Bạn có thể triển khai proxy API cho một môi trường hoặc cho 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 có thể cung cấp một số chức năng của Apigee. Ví dụ: dữ liệu bản đồ khoá-giá trị (KVM) có thể được cung cấp ở cấp tổ chức, nghĩa là các Proxy API được triển khai cho mọi môi trường sẽ nhận cùng 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ể thuộc phạm vi của tổ chức hoặc một môi trường cụ thể trong tổ chức. Dữ liệu phân tích của Apigee được phân chia 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:
