Hướng dẫn mongodb api calls - cuộc gọi api mongodb
Trên trang này Show
API dữ liệu ATLAS MongoDB cho phép bạn đọc và ghi dữ liệu trong ATLAS với các yêu cầu HTTPS tiêu chuẩn. Để sử dụng API dữ liệu, tất cả những gì bạn cần là máy khách HTTPS và khóa API hợp lệ. Khách hàng gửi các yêu cầu đến các điểm cuối cụ thể, mỗi điểm đại diện cho một hoạt động MongoDB. API bao gồm các điểm cuối tạo, đọc, cập nhật, xóa và tổng hợp các tài liệu trong cụm của bạn. Yêu cầu Chỉ định một bộ sưu tập và bao gồm các tham số dành riêng cho hoạt động như bộ lọc truy vấn hoặc mô tả cập nhật. Ngoài ra, tất cả các yêu cầu đến phải bao gồm khóa API dữ liệu để xác thực người dùng gọi. Đối với mỗi yêu cầu, API dữ liệu xác thực người dùng và kiểm tra quyền đọc/ghi của cụm. Nếu yêu cầu của người dùng được ủy quyền, thì API xác nhận yêu cầu, chạy hoạt động cơ sở dữ liệu tương ứng và trả về kết quả trong phản hồi HTTPS. Ví dụ: Yêu cầu bài đăng này lưu trữ một tài liệu trong Atlas bằng cách gọi điểm cuối 1:POST request stores a document in Atlas by calling the
1 endpoint:
Bạn có thể sử dụng API dữ liệu để tích hợp ATLAS vào bất kỳ ứng dụng và dịch vụ nào hỗ trợ các yêu cầu HTTPS. Ví dụ: bạn có thể:
Một hoạt động được gọi qua điểm cuối API có thể sẽ mất nhiều thời gian hơn so với hoạt động MongoDB tương ứng được gọi thông qua trình điều khiển MongoDB được kết nối. Đối với các trường hợp sử dụng tải cao và các ứng dụng nhạy cảm độ trễ, chúng tôi khuyên bạn nên kết nối trực tiếp với cơ sở dữ liệu của bạn với trình điều khiển MongoDB. Để tìm hiểu thêm, hãy truy cập tài liệu trình điều khiển MongoDB.MongoDB Drivers documentation. API dữ liệu không phải là kết nối trực tiếp với cơ sở dữ liệu của bạn. Thay vào đó, nó định tuyến các yêu cầu thông qua một lớp phần mềm trung gian được quản lý đầy đủ, được gọi là Dịch vụ ứng dụng Atlas, nằm giữa các ứng dụng cụm và ứng dụng khách của bạn. Lớp này xử lý xác thực người dùng và thực thi các quy tắc truy cập dữ liệu để đảm bảo rằng dữ liệu của bạn được bảo mật. Bạn có thể nhanh chóng thiết lập và truy cập API dữ liệu thông qua ATLAS, tạo ra và quản lý ứng dụng Dịch vụ ứng dụng cho bạn. ATLAS hỗ trợ xác thực khóa API với một số mô hình quyền cơ bản.quickly set up and access the Data API through Atlas, which creates and manages an App Services app for you. Atlas supports API key authentication with several basic permissions models. Bạn cũng có thể xác định các quyền truy cập API phức tạp hơn và các điểm cuối tùy chỉnh bằng cách truy cập trực tiếp vào ứng dụng API ATLAS Data API được quản lý hoặc bật API trong ứng dụng của riêng bạn. Để tìm hiểu thêm về các dịch vụ ứng dụng và cách API dữ liệu hoạt động, hãy xem API dữ liệu (Dịch vụ ứng dụng).Data API (App Services). Thực hiện theo các bước bên dưới để thiết lập API dữ liệu và gửi các yêu cầu đầu tiên của bạn. API dữ liệu bị tắt theo mặc định. Để sử dụng API, bạn cần bật nó trong Atlas UI cho một hoặc nhiều cụm. Nhấp vào API dữ liệu trong menu điều hướng bên trái. Trên màn hình sau, chọn một hoặc nhiều cụm mà bạn muốn bật API từ menu thả xuống và sau đó nhấp vào Bật API dữ liệu.Data API in the left navigation menu. On the following screen, select one or more clusters that you want to enable the API on from the dropdown menu and then click Enable the Data API. Ghi chúBạn có thể bật hoặc tắt API dữ liệu cho cụm bất cứ lúc nào từ màn hình API dữ liệu.Data API screen. API dữ liệu sử dụng các khóa API cấp dự án để quản lý truy cập và ngăn chặn các yêu cầu trái phép. Mỗi yêu cầu phải bao gồm khóa API dữ liệu hợp lệ. Một khóa API dữ liệu cấp cho truy cập đọc và ghi đầy đủ mỗi bộ sưu tập trong một cụm và có thể truy cập bất kỳ cụm nào được bật trong dự án. Quan trọngCác khóa API dữ liệu không giống như các khóa API lập trình được sử dụng để truy cập API ATLAS và APP Services Management API. Nhấp vào Tạo khóa API, nhập một tên duy nhất cho khóa mới, sau đó nhấp vào Tạo khóa API.Create API Key, enter a unique name for the new key, and then click Create API Key. Bây giờ bạn có thể xem và sao chép khóa API mới của mình lần đầu tiên và duy nhất. Khi bạn đóng phương thức, Atlas sẽ không bao giờ phơi bày giá trị nữa. Sao chép khóa API mới và lưu trữ ở một nơi nào đó an toàn, nơi bạn có thể tham khảo nó sau. Các khóa API dữ liệu rất nhạy cảm, vì vậy hãy đảm bảo không mã hóa chúng trực tiếp vào các ứng dụng hướng tới người dùng hoặc cam kết chúng điều khiển phiên bản. MẹoBạn có thể xóa khóa API dữ liệu bất cứ lúc nào. Bất kỳ yêu cầu bao gồm khóa đã xóa sẽ thất bại. Bạn có thể xóa khóa để ngăn khách hàng hiện tại tiếp tục sử dụng API hoặc nếu bạn vô tình để lộ khóa và cần thay thế nó. Bạn bao gồm khóa API dữ liệu của mình khi bạn gọi các điểm cuối hành động đọc và ghi tài liệu bằng MongoDB. Để biết danh sách tất cả các hành động và điểm cuối có sẵn, hãy xem tài nguyên API dữ liệu. Bạn có thể chạy các lệnh sau trong vỏ để đảm bảo mọi thứ hoạt động và sau đó bắt đầu khám phá: MẹoĐảm bảo thay thế các giá trị giữ chỗ trước khi bạn chạy từng yêu cầu:
Bạn có thể định cấu hình triển khai API của mình và cách người dùng tương tác với API. API dữ liệu sử dụng sơ đồ phiên bản tích hợp để nâng cấp các điểm cuối theo thời gian trong khi duy trì khả năng tương thích ngược. Các yêu cầu đến có thể chỉ định phiên bản nào của điểm cuối sẽ sử dụng trong URL yêu cầu và API dữ liệu có thể phục vụ bất kỳ phiên bản nào mà bạn đã bật. Bạn phải bật phiên bản mới trước khi người dùng có thể gọi điểm cuối với phiên bản đó. Bạn luôn có thể bật phiên bản API dữ liệu gần đây nhất. Tuy nhiên, bạn không thể bật phiên bản cũ hơn sau khi phiên bản mới hơn được phát hành. Các phiên bản sau đây hiện đang được hỗ trợ:
API dữ liệu ATLAS cho phép bạn xác định các quyền đọc/ghi cấp cụm áp dụng cho tất cả các yêu cầu đến. Bạn có thể xác định một trong những điều sau đây cho mỗi cụm:
Để có các quyền phức tạp hơn, bạn có thể xác định các quy tắc truy cập dữ liệu tùy chỉnh trong ứng dụng API ATLAS Data được quản lý.data access rules in the managed Atlas Data API app. API dữ liệu ATLAS hỗ trợ xác thực người dùng với các khóa API. Yêu cầu đến phải bao gồm khóa API trong tiêu đề yêu cầu. Bạn có thể tạo tối đa 100 khóa API dữ liệu. Để cho phép người dùng xác thực các yêu cầu với một phương thức khác, như tên người dùng và mật khẩu hoặc mã thông báo JSON Web, bạn có thể bật các nhà cung cấp xác thực bổ sung trong ứng dụng API ATLAS Data API được quản lý.authentication providers in the managed Atlas Data API app. Lớp dịch vụ ứng dụng chạy các quy trình API dữ liệu yêu cầu trên các máy chủ được quản lý được lưu trữ trong các khu vực triển khai trên toàn thế giới. Bạn có thể kiểm soát nơi bạn triển khai API dữ liệu của mình và các yêu cầu xử lý bằng một trong hai mô hình triển khai:
Các điểm cuối có thể trả về dữ liệu ở một trong hai định dạng dữ liệu, JSON hoặc EJSON.data formats, either JSON or EJSON. Theo mặc định, các điểm cuối trả về JSON, là một định dạng dữ liệu tiêu chuẩn được hỗ trợ rộng rãi trong các nền tảng và nền tảng hiện đại. Tuy nhiên, JSON không thể đại diện cho mọi loại dữ liệu mà bạn có thể lưu trữ trong MongoDB và mất thông tin loại cho một số loại dữ liệu. Bạn cũng có thể định cấu hình các điểm cuối để trả về EJSON, sử dụng các đối tượng JSON có cấu trúc để thể hiện đầy đủ các loại mà MongoDB hỗ trợ. Điều này bảo tồn thông tin loại trong các phản hồi nhưng yêu cầu ứng dụng của bạn hiểu cách phân tích và sử dụng EJSON. MẹoCác trình điều khiển MongoDB chính thức bao gồm các phương pháp làm việc với EJSON. Bạn cũng có thể tải xuống trình phân tích cú pháp độc lập như BSON trên NPM.bson on npm. Bạn có thể gọi điểm cuối API dữ liệu từ bất kỳ máy khách HTTP tiêu chuẩn nào. Mỗi yêu cầu có thể bao gồm các tiêu đề cấu hình và đối số trong thân yêu cầu. Yêu cầu API dữ liệu phải bao gồm tiêu đề 7 để chỉ định định dạng dữ liệu được sử dụng trong thân yêu cầu.data format used in the request body.
Yêu cầu có thể bao gồm tiêu đề 0 để yêu cầu định dạng dữ liệu cụ thể cho thân phản hồi, JSON hoặc EJSON. Nếu một yêu cầu không bao gồm tiêu đề 0 hợp lệ, phản hồi sử dụng định dạng dữ liệu được chỉ định trong cấu hình API dữ liệu của bạn.Data API configuration.Để giữ cho dữ liệu của bạn an toàn và chính xác, các điểm cuối API dữ liệu được tạo luôn chạy trong bối cảnh của một người dùng đã đăng ký cụ thể và tự động thực thi các quy tắc và lược đồ của ứng dụng của bạn. Các yêu cầu đến phải bao gồm một hoặc nhiều tiêu đề có chứa thông tin xác thực người dùng hợp lệ cho một trong các nhà cung cấp xác thực được kích hoạt sau:rules and schemas. Incoming requests must include one or more headers that contain valid user credentials for one of the following enabled authentication providers:
MongoDB lưu trữ dữ liệu theo định dạng gọi là BSON, tương tự như đối tượng JSON trong cấu trúc nhưng hỗ trợ các loại dữ liệu bổ sung và sử dụng mã hóa nhị phân. BSON hiệu quả cho máy tính nhưng không thể đọc được con người nên bạn không thể làm việc trực tiếp với nó. Thay vào đó, API dữ liệu sử dụng hai định dạng để biểu diễn dữ liệu trong các yêu cầu và phản hồi:
Thí dụTài liệu sau đây cho thấy các loại BSON được biểu thị trong JSON và EJSON: Bảng sau so sánh các biểu diễn JSON và EJSON của từng loại được hỗ trợ:
API dữ liệu ghi lại tất cả các yêu cầu và lưu trữ nhật ký trong 30 ngày. Bạn có thể xem chúng trên màn hình API dữ liệu trong tab nhật ký.Data API screen in the Logs tab. API dữ liệu thực thi các hạn chế sau trên tất cả các yêu cầu:
API dữ liệu giới hạn yêu cầu lưu lượng truy cập đến 5.000 yêu cầu đồng thời. Bất kỳ yêu cầu nào được thực hiện vượt quá giới hạn này trả về mã trạng thái phản hồi HTTP là 429 - quá nhiều yêu cầu. Bạn có thể yêu cầu giới hạn cao hơn bằng cách nộp vé hỗ trợ.429 - Too Many Requests. You can request a higher limit by filing a support ticket. API dữ liệu có giá dựa trên việc sử dụng được đo bằng ứng dụng dịch vụ ứng dụng cơ bản. Để biết chi tiết, xem thanh toán dịch vụ ứng dụng.App Services Billing. Việc sử dụng API dữ liệu được lập hóa đơn dựa trên các kích thước sau:
|