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 para la organización.

Trabajar con entornos

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:

La modificación de la configuración hace que el paquete actual se implemente nuevamente de manera automática para que los cambios surtan 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.

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.