Managed Runtime API

Use a Managed Runtime API para controlar os aplicativos implantados no Managed Runtime do Commerce Cloud. É possível criar ferramentas personalizadas com a mesma funcionalidade do aplicativo web do Runtime Admin, mas você tem com ele ainda mais opções de configuração e administração.

A Managed Runtime API serve somente para fins administrativos. Não faça solicitações à API no código de sua loja (virtual).

Este guia considera que você conhece o Managed Runtime e os conceitos relacionados, como projetos, ambientes, pacotes e implantações. To saber mais, veja Visão geral do Managed Runtime.

A marca Mobify ainda aparece no domínio mobify.com, no URL de base do Managed Runtime API. Embora novos domínios da Salesforce substituirão o domínio da Mobify, o domínio da Mobify ainda contará com suporte.

Para fazer solicitações à API, você precisa incluir uma chave de API no cabeçalho Authorization da solicitação HTTP com o valor Bearer $API_KEY.

Para encontrar a chave de API, faça logon na ferramenta Runtime Admin e vá para a página Configurações de conta.

Trate sua chave de API como trataria a uma senha, pois ela permite executar operações em seu nome.

Você verá como usar a API em um breve tutorial que mostra algumas solicitações de amostra, formatadas como comandos curl.

Antes de executar os comandos, substitua qualquer espaço reservado por valores reais. Os espaços reservados são formatados da seguinte maneira: $PLACEHOLDER.

Para a maioria das solicitações, você deve substituir $PROJECT_ID por seu ID do projeto real. Para encontrar seu ID do projeto, faça logon na ferramenta Runtime Admin e vá para a página de configurações do seu projeto.

Os IDs de projeto podem ter até 20 caracteres e precisam ser exclusivos globalmente.

Nossa primeira solicitação ao Managed Runtime API enumera todos os ambientes (ou “destinos”, como são chamados na API) que pertencem a um projeto:

Chame o projects_target_list endpoint da API para listar os ambientes:

Agora vamos criar um ambiente chamado staging que podemos usar para verificar as mudanças antes de implantá-las em production:

Primeiro, chame o projects_target_create endpoint da API. Se estiver criando um projeto, você pode chamar projects_create endpoint da API para também criar um ambiente:

Em seguida, chame o cc_b2c_target_info_update endpoint da API para conectar uma instância Commerce Cloud e um ou mais sites ao ambiente.

Para usar o novo ambiente, você deve *implantar um pacote nele.

Vamos chamar o projects_target_retrieve endpoint da API para revisar os detalhes do ambiente staging que criamos:

Finalmente, vamos chamar o projects_target_partial_update endpoint da API para modificar a configuração do proxy para staging:

A alteração da configuração reimplementa o pacote já implementado para que a atualização na configuração entre em vigor.

Se você estiver com problemas para usar a API, tente uma das etapas de solução de problemas abaixo.

  • Adicione o argumento --fail ao seu comando curl.
  • Verifique sua chave de API.
  • Verifique o ID do seu projeto.

Os endpoints da API também funcionam em um navegador. Faça logon na ferramenta Runtime Admin e depois abra diretamente no navegador o endpoint que você está usando.

Para obter implementação e integração contínuas usando a Managed Runtime API, crie um usuário do Account Manager para automação:

  • Crie uma conta de usuário no Account Manager usando um endereço de e-mail compartilhado como um Google Group. Armazene as credenciais e o código MFA associados em um gerenciador de senhas como LastPass.
  • Conceda ao usuário a função Managed Runtime User.
  • Atribua ao usuário a permissão exigida no Runtime Admin. A chave Managed Runtime API do usuário só pode acessar o que está autorizado pelas permissões atribuídas. Garanta que elas sejam exclusivas para os projetos relacionados à atuação do CI/CD.
  • Crie uma chave de API para o usuário e salve-a em seu sistema de integração contínua.

Para manter ativa a chave da Managed Runtime API, você precisa manter ativa a conta relacionada do Account Manager atualizando a senha conforme exigido pela configuração do Account Manager da sua organização. Se o usuário estiver desativado, faça a reativação redefinindo a senha para reativar a chave da API.

A Managed Runtime API tem limites de taxa definidos para o número de solicitações permitidas por unidade de tempo. Os limites de taxa são aplicados por usuário e ajudam a garantir que todos os usuários tenham acesso justo.

Se a sua solicitação ultrapassa o limite de taxa, a API retorna um erro HTTP 429 Too Many Requests e um cabeçalho HTTP Retry-After que indica o número de segundos até que você possa tentar de novo.

Os limites de taxa não podem ser ajustados.

As tabelas abaixo indicam os limites de taxa para diferentes famílias de API.

Alguns endpoints apresentam limites de taxa cumulativos, o que significa que não são limitados individualmente. Em vez disso, limites de taxa cumulativos limitam o número combinado de solicitações de vários endpoints. Todas as solicitações GET apresentam um limite de taxa cumulativo. Do mesmo modo, todas as solicitações POST, PATCH e DELETE para endpoints que não são mencionados individualmente nas tabelas a seguir apresentam um limite de taxa cumulativo. Esses limites são descritos abaixo.
MétodoEndpoint
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/
Limite cumulativo de 1 minutoLimite cumulativo de 1 hora
10100
MétodoEndpointLimite de 5 minutosLimite de 1 hora
POST/api/projects/*/target/*/invalidation/15100
MétodoEndpointLimite de 1 minutoLimite de 1 hora
GETTodos os endpoints combinados.1000N/A
POST, PATCH, DELETETodos os endpoints restantes combinados.100N/A

Agora você sabe o que a API pode fazer, e pôde até mesmo fazer algumas solicitações de amostra!

Para saber mais sobre a API, consulte a Especificação da API.

Os esquemas de Open API para a API estão disponíveis em: