Managed Runtime API

Utilice Managed Runtime API para controlar las aplicaciones implementadas en Managed Runtime de Commerce Cloud. Puede crear herramientas personalizadas que tienen la misma funcionalidad que la aplicación web Runtime Admin, pero obtiene aún más capacidades de administración y opciones de configuración.

Managed Runtime API es solo para fines de administración. No haga solicitudes a la API en el código de su storefront.

Esta guía asume que usted ya está familiarizado con Managed Runtime y los conceptos relacionados, tales como: proyectos, entornos, paquetes y despliegues. Para obtener más información, consulte la sección Visión general de Managed Runtime.

La marca Mobify todavía aparece en el dominio mobify.com en la URL base de la Managed Runtime API. Si bien los nuevos dominios de Salesforce acabarán reemplazando al dominio de Mobify, el soporte para el dominio de Mobify continuará.

Para realizar solicitudes de API, debe incluir una clave de API en el encabezado de la solicitud de HTTP Authorization con el valor, Bearer $API_KEY.

Para encontrar su clave de API, inicie sesión en la herramienta Runtime Admin y vaya a la página Configuración de la cuenta.

Trate su clave de API como una contraseña porque permite que los scripts realicen operaciones por usted.

Vamos a mostrarle cómo utilizar la API con un breve tutorial basado en algunas solicitudes de ejemplo, formateadas como comandos curl.

Antes de ejecutar los comandos, sustituya los marcadores de posición con los valores reales. Los marcadores de posición tienen el siguiente formato: $PLACEHOLDER.

Para la mayoría de las solicitudes, se debe sustituir $PROJECT_ID con el código de identificación del proyecto real. Para buscar el código de identificación de su proyecto, inicie sesión en la herramienta Runtime Admin y vaya a la página de configuración de este.

Los códigos de identificación del proyecto pueden tener hasta 20 caracteres y deben ser únicos globalmente.

Nuestra primera solicitud a la Managed Runtime API enumera todos los entornos (u "objetivos", como se denominan en la API) que pertenecen a un proyecto:

Creemos ahora un entorno llamado staging que podemos utilizar para verificar los cambios antes de implementarlos en production:

Para utilizar su nuevo entorno, debe implementar un paquete en él.

Revisemos los detalles del entorno staging que ya creamos:

Por último, vamos a modificar la configuración del proxy para staging:

Cambiar la configuración vuelve a implementar el paquete implementado para que la actualización de la configuración surta efecto.

Si tiene problemas para utilizar la API, intente estos pasos de solución de problemas.

Agregue el argumento--fail al comando curl.
Verifique la clave de API.
Compruebe el código de identificación del proyecto.

Los extremos de la API también funcionan en un navegador. Inicie sesión en la herramienta Runtime Admin y luego abra el extremo que está usando directamente en su navegador.

Para admitir la integración y la implementación continuas mediante la API Managed Runtime, cree un usuario de Account Manager para la automatización:

Cree una cuenta de usuario en el Account Manager utilizando una dirección de correo electrónico compartida como un grupo de Google. Guarde las credenciales asociadas y el código MFA en un administrador de contraseñas como LastPass.
Dele al usuario el rol Managed Runtime User.
Asigne al usuario los permisos necesarios en Runtime Admin. La clave API de Managed Runtime del usuario solo puede acceder a lo que permiten los permisos del usuario. Manténgalos específicos para los proyectos con los que CI/CD necesita interactuar.
Cree la clave API para el usuario y guárdela en su sistema de integración continua.

Para mantener activa la clave de API de Managed Runtime, debe mantener activa la cuenta del Account Manager relacionada actualizando su contraseña según lo requiera la configuración de Account Manager de su organización. Si el usuario está desactivado, reactívelo restableciendo la contraseña para volver a habilitar la clave API.

La API de Managed Runtime tiene tasas límites para el número de solicitudes permitidas por unidad de tiempo. Las tasas límites se aplican por usuario y ayudan a garantizar un acceso justo para todos los usuarios.

Si su solicitud excede una tasa límite, la API devuelve un error HTTP 429 Too Many Requests y un encabezado HTTP Retry-After que indica el número de segundos que debe esperar hasta que pueda volver a intentarlo.

Las tasas límites no se pueden ajustar.

Las tablas a continuación indican las tasas límites para diferentes familias de API.

Algunos puntos de conexión tienen tasas límites acumulativas, lo que significa que no están limitados por punto de conexión. En cambio, las tasas límites acumulativas limitan el número combinado de solicitudes en múltiples puntos de conexión. Todas las solicitudes GET tienen una tasa límite acumulativa. De manera similar, todas las solicitudes POST, PATCH y DELETE para puntos de conexión que no se llaman individualmente en las siguientes tablas tienen una tasa límite acumulativa. Estos límites se describen a continuación.

Método	Punto de conexión
POST	`/api/projects/`
PATCH	`/api/projects/*/`
DELETE	`/api/projects/*/`
POST	`/api/projects//builds//`
POST	`/api/projects/*/target/`
PATCH	`/api/projects//target//`
DELETE	`/api/projects//target//`
POST	`/api/projects//target//deploy/`

Límite de 1 minuto acumulativo	Límite de 1 hora acumulativo
10	100

Método	Punto de conexión	Límite de 1 minuto	Límite de 1 hora
POST	`/api/projects//target//invalidation/`	20	200

Método	Punto de conexión	Límite de 1 minuto	Límite de 1 hora
GET	Todos los puntos de conexión combinados.	1000	N/A
POST, PATCH, DELETE	Todos los puntos de conexión restantes combinados.	100	N/A

Ahora ya está familiarizado con lo que puede hacer la API, e incluso ha hecho algunas solicitudes de ejemplo.

Para obtener más información sobre las API, consulte Especificaciones de la API.

El esquema de API abierta para API está disponible en: https://cloud.mobify.com/api/schema.json