Hướng dẫn what is data api in mongodb atlas? - api dữ liệu trong tập bản đồ mongodb là gì?

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ọng

Cá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ẹo

Bạ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:

• curl --request POST \
    'https://data.mongodb-api.com/app//endpoint/data/v1/action/findOne' \
    --header 'Content-Type: application/json' \
    --header 'api-key: ' \
    --data-raw '{
        "dataSource": "",
        "database": "learn-data-api",
        "collection": "people",
        "filter": { "name": "John Sample" }
    }'

  2: ID ứng dụng API dữ liệu của bạn, mà bạn có thể tìm thấy trong phần điểm cuối URL của UI.URL Endpoint section of the UI.

• curl --request POST \
    'https://data.mongodb-api.com/app//endpoint/data/v1/action/findOne' \
    --header 'Content-Type: application/json' \
    --header 'api-key: ' \
    --data-raw '{
        "dataSource": "",
        "database": "learn-data-api",
        "collection": "people",
        "filter": { "name": "John Sample" }
    }'

  3: Khóa API dữ liệu bạn vừa tạo.

• curl --request POST \
    'https://data.mongodb-api.com/app//endpoint/data/v1/action/findOne' \
    --header 'Content-Type: application/json' \
    --header 'api-key: ' \
    --data-raw '{
        "dataSource": "",
        "database": "learn-data-api",
        "collection": "people",
        "filter": { "name": "John Sample" }
    }'

  4: Tên của một cụm có API dữ liệu được bật.

1. Chèn một tài liệu kiểm tra:

   curl --request POST \
     'https://data.mongodb-api.com/app//endpoint/data/v1/action/insertOne' \
     --header 'Content-Type: application/json' \
     --header 'api-key: ' \
     --data-raw '{
         "dataSource": "",
         "database": "learn-data-api",
         "collection": "people",
         "document": {
           "name": "John Sample",
           "age": 42
         }
     }'

2. Sau đó, tìm tài liệu kiểm tra mà bạn vừa chèn:

   curl --request POST \
     'https://data.mongodb-api.com/app//endpoint/data/v1/action/findOne' \
     --header 'Content-Type: application/json' \
     --header 'api-key: ' \
     --data-raw '{
         "dataSource": "",
         "database": "learn-data-api",
         "collection": "people",
         "filter": { "name": "John Sample" }
     }'

3. Cuối cùng, xóa tài liệu kiểm tra:

   curl --request POST \
     'https://data.mongodb-api.com/app//endpoint/data/v1/action/deleteOne' \
     --header 'Content-Type: application/json' \
     --header 'api-key: ' \
     --data-raw '{
         "dataSource": "",
         "database": "learn-data-api",
         "collection": "people",
         "filter": { "name": "John Sample" }
     }'

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ợ:

• curl --request POST \
    'https://data.mongodb-api.com/app//endpoint/data/v1/action/findOne' \
    --header 'Content-Type: application/json' \
    --header 'api-key: ' \
    --data-raw '{
        "dataSource": "",
        "database": "learn-data-api",
        "collection": "people",
        "filter": { "name": "John Sample" }
    }'

  5

• curl --request POST \
    'https://data.mongodb-api.com/app//endpoint/data/v1/action/findOne' \
    --header 'Content-Type: application/json' \
    --header 'api-key: ' \
    --data-raw '{
        "dataSource": "",
        "database": "learn-data-api",
        "collection": "people",
        "filter": { "name": "John Sample" }
    }'

  6

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 và viết: Yêu cầu có thể đọc tất cả dữ liệu và có thể chèn, sửa đổi hoặc xóa dữ liệu trong bất kỳ bộ sưu tập nào.: Requests can read all data and can insert, modify, or delete data in any collection.

• Chỉ đọc: Yêu cầu có thể đọc tất cả dữ liệu trong bất kỳ bộ sưu tập nào nhưng không thể viết bất kỳ dữ liệu nào.: Requests can read all data in any collection but cannot write any data.

• Không có quyền truy cập: Yêu cầu không thể đọc hoặc viết bất kỳ dữ liệu nào trong bất kỳ bộ sưu tập nào.: Requests can't read or write any data in any collection.

Để 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:

• Triển khai toàn cầu lưu trữ API của bạn trên các máy chủ ở mọi khu vực được hỗ trợ trên toàn thế giới. API tự động định tuyến và xử lý các yêu cầu đến đến máy chủ gần nhất với người dùng yêu cầu. deployment hosts your API on servers in every supported region across the world. The API automatically routes and processes incoming requests to the server that's nearest to the requesting user.

• Triển khai cục bộ lưu trữ các máy chủ API của bạn trong một khu vực triển khai cụ thể trong AWS hoặc Azure. API xử lý tất cả các yêu cầu đến trong khu vực địa phương. deployment hosts your API servers in one specific deployment region in AWS or Azure. The API processes all incoming requests in the local region.

  Để biết danh sách các khu vực được hỗ trợ, hãy xem các mô hình & khu vực triển khai trong tài liệu dịch vụ ứng dụng.Deployment Models & Regions in the App Services docs.

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ẹo

Cá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.

Yêu cầu API dữ liệu phải bao gồm tiêu đề

curl --request POST \
  'https://data.mongodb-api.com/app//endpoint/data/v1/action/findOne' \
  --header 'Content-Type: application/json' \
  --header 'api-key: ' \
  --data-raw '{
      "dataSource": "",
      "database": "learn-data-api",
      "collection": "people",
      "filter": { "name": "John Sample" }
  }'

• Sử dụng

  curl --request POST \
    'https://data.mongodb-api.com/app//endpoint/data/v1/action/findOne' \
    --header 'Content-Type: application/json' \
    --header 'api-key: ' \
    --data-raw '{
        "dataSource": "",
        "database": "learn-data-api",
        "collection": "people",
        "filter": { "name": "John Sample" }
    }'

  8 để biểu diễn các loại JSON tiêu chuẩn trong thân yêu cầu API dữ liệu.

• Sử dụng

  curl --request POST \
    'https://data.mongodb-api.com/app//endpoint/data/v1/action/findOne' \
    --header 'Content-Type: application/json' \
    --header 'api-key: ' \
    --data-raw '{
        "dataSource": "",
        "database": "learn-data-api",
        "collection": "people",
        "filter": { "name": "John Sample" }
    }'

  9 để biểu thị các loại JSON tiêu chuẩn và các loại EJSON bổ sung trong thân yêu cầu API dữ liệu.

Yêu cầu có thể bao gồm tiêu đề

curl --request POST \
  'https://data.mongodb-api.com/app//endpoint/data/v1/action/deleteOne' \
  --header 'Content-Type: application/json' \
  --header 'api-key: ' \
  --data-raw '{
      "dataSource": "",
      "database": "learn-data-api",
      "collection": "people",
      "filter": { "name": "John Sample" }
  }'

curl --request POST \
  'https://data.mongodb-api.com/app//endpoint/data/v1/action/deleteOne' \
  --header 'Content-Type: application/json' \
  --header 'api-key: ' \
  --data-raw '{
      "dataSource": "",
      "database": "learn-data-api",
      "collection": "people",
      "filter": { "name": "John Sample" }
  }'

Để 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:

• Email/Password

• Mã API

• JWT tùy chỉnh