API de administración de servicios de aplicaciones de MongoDB Atlas
3.0

URL base

https://services.cloud.mongodb.com/api/admin/v3.0

Aviso de fin de vida útil (EOL)

LOS SERVICIOS DE LA APLICACIÓN HAN LLEGADO AL FIN DE SU VIDA ÚTIL (EOL). Atlas Device Sync, los SDK, la API de datos, GraphQL, el alojamiento estático y los puntos finales HTTPS alcanzaron el EOL el de septiembre 30 2025del. Los activadores de la base de datos siguen disponibles.

Esto afecta a otras funciones de App Service, como la autenticación y la gestión de usuarios, las funciones, el protocolo Wire y los permisos de acceso a datos. Los puntos finales de API relacionados con estas funciones están obsoletos.

Para obtener más información, consulte la página de obsolescencia: https://www.mongodb.com/es/docs/atlas/app-services/deprecation/.

API Overview

La API de administración de App Services permite realizar tareas administrativas mediante programación a través de HTTPS. Esto incluye definir y configurar aspectos como:

Implementación y seguridad de aplicaciones
API y puntos finales
Autenticación y gestión de usuarios
Fuentes de datos
Sincronización de dispositivos
Entornos
Funciones
Registros
Reglas
Schemas
Alojamiento estático
Activadores
Métricas de uso y facturación
Values & Secrets

La API de administración es para el desarrollo de aplicaciones, configuración y implementación. Para utilizar las funcionalidades que configuras con la API de administración, las aplicaciones cliente se conectan con una API HTTPS específica para tu aplicación.

ID de proyectos y aplicaciones

Nota: los términos ID del proyecto y ID del grupo son intercambiables.

Los puntos finales de la API de administración de Atlas App Services con frecuencia requieren que incluya dos parámetros en la URL:

Su ID de proyecto Atlas (también llamado a veces ID de grupo)
Su ID de aplicación deApp Services

Identificación del proyecto

Puede encontrar el ID de su proyecto desde el panel de MongoDB Atlas o con la CLI de MongoDB Atlas.

ID de aplicación

Para encontrar un ID de aplicación, realiza una solicitud al punto final "List Apps" de tu proyecto. Necesitarás un access_token para realizar esta solicitud. Para saber cómo obtenerlo,consulta "Obtener un token de acceso a la sesión de la API de administración".

curl --request GET \
  --header 'Authorization: Bearer <access_token>' \
  https://services.cloud.mongodb.com/api/admin/v3.0/groups/{groupId}/apps

Esto devolverá una lista de objetos que describen cada aplicación de App Services en el proyecto/grupo proporcionado. Para las solicitudes de la API de administración, el ID de la aplicación es el valor de ObjectId en el _id campo, client_app_idno.

[
  {
    "_id": "5997529e46224c6e42gb6dd9",
    "group_id": "57879f6cc4b32dbe440bb8c5",
    "domain_id": "5886619e46124e4c42fb5dd8",
    "client_app_id": "myapp-abcde",
    "name": "myapp",
    "location": "US-VA",
    "deployment_model": "GLOBAL",
    "last_used": 1615153544,
    "last_modified": 0,
    "product": "standard",
    "environment": ""
  }
]

Obtener un token de acceso a la sesión de API de administrador

Cada solicitud a la API de administración de App Services debe incluir un token de acceso válido y vigente emitido por la API de MongoDB Cloud. Este token se incluye en el encabezado Authorization de cada solicitud mediante el esquema de autenticación de portador.

Necesita una clave API programática de MongoDB Atlas válida para que MongoDB Atlas obtenga un token.

Una vez que tenga un par de claves API, llame al punto final de autenticación:

curl --request POST \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --data '{"username": "<Public API Key>", "apiKey": "<Private API Key>"}' \
  https://services.cloud.mongodb.com/api/admin/v3.0/auth/providers/mongodb-cloud/login

Si la autenticación es exitosa, App Services devuelve un token de acceso como parte del documento de respuesta JSON:

{
  "access_token": "<access_token>",
  "refresh_token": "<refresh_token>",
  "user_id": "<user_id>",
  "device_id": "<device_id>"
}

El access_token representa una autorización por tiempo limitado para interactuar con la API de administración. Para autenticar una solicitud, incluya el token en el Authorization encabezado del token de portador.

Authorization: Bearer <access_token>

Actualizar un token de acceso a la sesión de API de administrador

Los tokens de acceso a la sesión caducan 30 minutos después de su emisión. Al iniciar sesión, la respuesta también incluye un refresh_token que puede usar para obtener un nuevo token de acceso. Esto es útil porque solo necesita iniciar sesión con credenciales una vez. Después, puede usar el token de actualización para volver a autenticarse mientras sea válido.

De forma predeterminada, los tokens de actualización caducan 60 días después de su emisión. Puede personalizar la caducidad del token de actualización con un mínimo de 30 minutos o un máximo de 5 años.

Para actualizar su autenticación y obtener un nuevo access_token, llame al punto final de la sesión de autenticación con su refresh_token en el encabezado Authorization:

curl --request POST \
  --header 'Authorization: Bearer <refresh_token>' \
  https://services.cloud.mongodb.com/api/admin/v3.0/auth/session

Si el token de actualización es válido, el cuerpo de la respuesta incluye un nuevo access_token que es válido durante los próximos 30 minutos:

{
  "access_token": "<access_token>"
}

Esta es la versión 3.0 de la documentación de la API. Última actualización: 23 de septiembre de 2025.

API de administración de servicios de aplicaciones de MongoDB Atlas 3.0