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.

Consideraciones

Managed Runtime API es solo para fines de administración. No haga solicitudes a la API en el código de su escaparate. Las solicitudes que superan los límites de frecuencia se bloquean.

Warning

Para leer variables de entorno desde el storefront, use process.env.
Para leer y cargar redireccionamientos, use el punto /mobify/redirects/$pathde conexión administrado.

Antes de comenzar

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

Note

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.

Note

Tutorial

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.

Entornos de lista

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:

Llame al punto de conexión de la projects_target_list API para enumerar los entornos:

1curl "https://cloud.mobify.com/api/projects/$PROJECT_ID/target/" \
2  --header "Authorization: Bearer $API_KEY"

Crear un entorno

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

En primer lugar, llame al punto de conexión de la projects_target_create API. Si está creando un proyecto, puede llamar al punto de conexión de la projects_create API para crear también un entorno:

1curl "https://cloud.mobify.com/api/projects/$PROJECT_ID/target/" \
2  --request 'POST' \
3  --header "Authorization: Bearer $API_KEY" \
4  --header 'Content-Type: application/json' \
5  --data '{"name": "staging"}'

Luego, llame al punto de conexión de la cc_bAPI 2c_target_info_update para conectar una instancia de Commerce Cloud y uno o más sitios al entorno.

1curl "https://cloud.mobify.com/api/cc/b2c/projects/$PROJECT_ID/b2c-target-info/staging/" \
2  --request 'PUT' \
3  --header "Authorization: Bearer $API_KEY" \
4  --header 'Content-Type: application/json' \
5  --data '{"instance_id": "aaaa_stg", "sites": ["DemoSite1", "DemoSite2"]}'

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

Llamemos al punto de conexión de la projects_target_retrieve API para revisar los detalles del staging entorno que creamos:

1curl "https://cloud.mobify.com/api/projects/$PROJECT_ID/target/staging/" \
2  --header "Authorization: Bearer $API_KEY"

Verificar la configuración del proxy

Por último, llamemos al punto de conexión de la projects_target_partial_update API para modificar la configuración del proxy para: staging

1curl "https://cloud.mobify.com/api/projects/$PROJECT_ID/target/staging/" \
2  --request 'PATCH'  \
3  --header "Authorization: Bearer $API_KEY" \
4  --header 'Content-Type: application/json' \
5  --data '{"ssr_proxy_configs": [{"path": "api", "host": "kv7kzm78.api.commercecloud.salesforce.com"}]}'

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

Solución de problemas

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.

Usuarios de automatización 🤖

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.

Tasas límites

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.

Cómo Leer los Números

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.

Important

Proyectos y Entornos

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

Invalidaciones del caché

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

Límites de tasa predeterminados

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

Siguientes pasos

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.

Los esquemas de Open API para la API están disponibles en:

Administrador de MRT: https://cloud.mobify.com/api/schema.json
Configuración de MRT B2C: https://cloud.mobify.com/api/cc/b2c/schema.json