Managed Runtime API

Use the Managed Runtime API to control applications deployed to B2C Commerce’s Managed Runtime. You can create custom tooling that has the same functionality as the Runtime Admin web application, but you get even more administration abilities and configuration options.

• To read environment variables from the storefront, use process.env.
• To read and load redirects use the managed endpoint /mobify/redirects/$path.

This guide assumes that you’re already familiar with Managed Runtime and related concepts, such as: projects, environments, bundles, and deployments. To learn more, see the Managed Runtime Overview.

To make API requests, you must include an API key in the HTTP request Authorization header with the value, Bearer $API_KEY.

To find your API key, log in to the Runtime Admin tool and go to the Account Settings page.

We’re about to show you how to use the API with a brief tutorial based on some sample requests, which are formatted as curl commands.

Before running the commands, replace any placeholders with actual values. Placeholders are formatted like this: $PLACEHOLDER.

For most requests, you must replace $PROJECT_ID with your actual project ID. To look up your project ID, log in to the Runtime Admin tool and go to your project’s settings page.

Project IDs can be up to 20 characters long and must be unique globally.

Our first request to the Managed Runtime API lists all the environments (or “targets” as they’re called in the API) that belong to a project:

Call the projects_target_list API endpoint to list the environments:

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

Now let’s create an environment called staging that we can use to verify changes before deploying them to production:

First call the projects_target_create API endpoint. If you’re creating a project, you can call the projects_create API endpoint to also create an environment:

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"}'

Then call the cc_b2c_target_info_update API endpoint to connect a B2C Commerce instance and one or more sites to the environment.

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"]}'

To use your new environment, you must deploy a bundle to it.

Let’s call the projects_target_retrieve API endpoint to review the details of the staging environment that we created:

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

Finally, let’s call the projects_target_partial_update API endpoint to modify the proxy configuration for 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"}]}'

Changing the configuration redeploys the deployed bundle so that the configuration update takes effect.

If you’re having trouble using the API, try these troubleshooting steps.

• Add the --fail argument to your curl command.
• Check your API key.
• Check your project’s ID.

The API endpoints also work in a browser. Log in to the Runtime Admin tool then open the endpoint you’re using directly in your browser.

To support continuous integration and deployment using the Managed Runtime API, create an Account Manager user for automation:

• Create a user account in Account Manager using a shared email address like a Google Group. Store the associated credentials and MFA code in a password manager like LastPass.
• Give the user the Managed Runtime User role.
• Assign the user the required permissions in Runtime Admin. The user’s Managed Runtime API key can only access what is allowed by the user’s permissions. Keep them specific to the projects that CI/CD needs to interact with.
• Create the API key for the user and save it in your continuous integration system.

To keep the Managed Runtime API key active, you must keep the related Account Manager account active by updating its password as required by your organization’s Account Manager configuration. If the user is deactivated, reactivate it by resetting the password to re-enable the API key.

The Managed Runtime API has rate limits in place for the number of requests allowed per unit of time. Rate limits are applied on a per-user basis, and help ensure fair access for all users.

If your request exceeds a rate limit, the API returns an HTTP 429 Too Many Requests error, and a Retry-After HTTP header that indicates the number of seconds to wait until you can retry.

Rate limits cannot be adjusted.

The tables below indicate the rate limits for different API families.

Now you’re familiar with what the API can do—and even made some sample requests!

To learn more about the API, refer to the API Specification.

The Open API schemas for the API are available at:

• MRT Admin: https://cloud.mobify.com/api/schema.json
• MRT B2C Config: https://cloud.mobify.com/api/cc/b2c/schema.json

j

Announcements

Choose Your B2C Commerce Storefront Type

B2C Commerce

SCAPI

Storefront Next

Composable Storefront

Composable Storefront Overview

Quick Start

Deploy Your Code

Skills for Success

Introduction to Composable Storefront

Best Practices Checklist

Headless Commerce with Salesforce Commerce API

PWA Kit Overview

Managed Runtime Overview

Managed Runtime API

PWA Kit Compatibility Matrix

Use Composable Storefront in a Hybrid Implementation

PWA Kit Framework

Performance Guide for Composable Storefronts

Get Set Up

Build Your Site

Enable Your Merchant Team

Test, Launch, and Monitor

Maintain

Composable Storefront Specifications

Storefront Reference Architecture (SFRA)

Commerce Apps ISV Developer Guide

B2C Commerce Solutions

B2C Commerce Release Notes

B2C Commerce Reference Information

Ask the Community