Managed Runtime API

Use a API do Managed Runtime 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.

O 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ê deve incluir uma chave de API no cabeçalho de solicitação de HTTP Authorization 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 devem ser exclusivos à organização.

Trabalhar com ambientes

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:

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

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

Vejamos os detalhes do ambiente staging que criamos:

Finalmente, vamos modificar a configuração de proxy para staging:

Mudar a configuração faz com que o pacote atual seja implantado novamente, e de maneira automática, para que as mudanças sejam efetivadas.

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

  • Adicione o argumento --fail a 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.

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 Especificação da API.