A Data API atingiu seu status de fim de vida útil e não é mais ativamente suportada pelo MongoDB. Esta página é mantida apenas para referência histórica. Para obter mais informações, consulte Descontinuação da Data API e dos pontos de conexão HTTPS.
A Data API era um serviço gerenciado que permitia a você trabalhar com segurança com dados armazenados no Atlas utilizando requisições HTTPS padrão. A Data API não é uma conexão direta com seu banco de dados. Em vez disso, a API é um serviço de middleware totalmente gerenciado que fica entre seu cluster e os clientes que enviam solicitações.
Você pode utilizar a API de dados para conectar ao MongoDB Atlas a partir de qualquer plataforma que suporte HTTPS, incluindo:
Navegadores da Web
Servidores da Web
Pipelines CI/CD
Aplicativos móveis
Dispositivos da Internet das Coisas
Você não precisa instalar nenhum driver de banco de dados ou bibliotecas suspensas para trabalhar com a API de dados. Em vez disso, você envia requisições HTTPS padrão como a seguinte:
curl -s "https://data.mongodb-api.com/app/myapp-abcde/endpoint/data/v1/action/insertOne" \ -X POST \ -H "Content-Type: application/ejson" \ -H "Accept: application/json" \ -H "apiKey: TpqAKQgvhZE4r6AOzpVydJ9a3tB1BLMrgDzLlBLbihKNDzSJWTAHMVbsMoIOpnM6" \ -d '{ "dataSource": "mongodb-atlas", "database": "learn-data-api", "collection": "hello", "document": { "text": "Hello, world!" } }'
{ "insertedId": "63dc56ac74ddb86ed3eb8474" }
Endpoints [Fim da vida útil]
A Data API aceitava dois tipos de endpoints:
Os endpoints daData API foram endpoints gerados automaticamente, cada um representando uma operação do MongoDB . Você pode usar os endpoints para criar, ler, atualizar, excluir e agregar documentos em uma fonte de dados MongoDB .
Os endpointspersonalizados eram rotas de API específicas do aplicativo manipuladas pelas funções do Atlas que você escreve. Você pode usar endpoints personalizados para definir as operações que se adequam especificamente ao seu caso de uso. Por exemplo, você pode criar um endpoint que executa uma agregação predefinida ou que se integra a um serviço de webhook externo.
Como funcionava a Data API [Fim da vida útil]
As solicitações de API de dados podem se assemelhar a operações de banco de dados tradicionais, como find ou insertOne, mas a API de dados não é uma conexão direta ao seu banco de dados. Em vez disso, a API de dados adiciona verificações adicionais de autenticação, autorização e correção para garantir que seus dados sejam acessados ou modificados apenas das maneiras permitidas. Isto permite a você acessar dados com segurança no Atlas a partir de clientes potencialmente vulneráveis como aplicações da Web.
Para cada solicitação recebida, a API de dados:
Autenticado o usuário chamador. Isso pode envolver a validação de um token de acesso, login com credenciais de cabeçalho ou diretamente atribuir um usuário de tempo de execução específico com base em sua configuração.
Autorizado o pedido. Isso garante que o usuário enviou uma solicitação bem formada e tem permissão para executar a operação solicitada com base em seu esquema de autorização de endpoint.
Execute a operação solicitada. Isso pode envolver ler ou escrever dados no Atlas com um ponto de conexão gerado ou invocar uma função personalizada que você escreveu.
Para solicitações que leem ou escrevem dados no Atlas, a API de dados também impõe as regras de controle de acesso e os esquemas de documentos definidos em sua aplicação. Isso significa que os usuários só podem acessar dados que eles tenham autorização para ler e escrever. As solicitações falharão se incluírem uma operação de escrita inválida.
Retornou uma resposta HTTPS para o chamador. A resposta incluiu o resultado de uma operação de endpoint gerada ou quaisquer dados que você retorne de um endpoint personalizado. Na solicitação, você pode optar por receber a resposta no formato JSON ou EJSON.
Quando usar a Data API [Fim da vida útil]
Para aplicativos de servidor , e especialmente para casos de uso sensíveis a alta carga e latência, recomendamos uma conexão direta ao Atlas com um driver MongoDB . As operações chamadas por meio de um endpoint da Data API levam mais tempo para serem concluídas do que as operações MongoDB correspondentes chamadas por meio de um driver. Além disso, os drivers fornecem mais flexibilidade e controle sobre como suas operações são executadas. Para saber mais, visite a documentação do MongoDB Drivers.
Você não pode mais usar a Data API. Antes de ser descontinuado, recomendamos usar a Data API quando:
Você deve executar operações do MongoDB a partir de um aplicativo da Web ou outro cliente em que não pode confiar.
Você não puder ou não quiser gerenciar um driver MongoDB em seu ambiente no lado do servidor. Por exemplo, alguns ambientes de computação de borda não oferecem suporte a drivers de banco de dados ou pool de conexões.
Você quiser desenvolver uma nova funcionalidade e preferir uma solução flexível para trabalhar primeiro no lado do cliente antes de criar e refinar a camada da API.
Você deseja integrar o acesso aos dados do Atlas em um gateway de API federado.
Você deseja se conectar ao Atlas App Services a partir de um ambiente atualmente não compatível com um Atlas Device SDK e não quer usar um driver para se conectar pelo protocolo de conexão.
Restrições [Fim da vida útil]
As seguintes restrições se aplicam a solicitações e respostas do Data API:
As solicitações expirarão após 300 segundos de execução.
As cargas úteis de resposta da API de dados são limitadas a 350 MB de tamanho.