Criar e monitorar uma sandbox sob demanda

Objetivos de aprendizagem

Após concluir esta unidade, você estará apto a:

• Autorizar a API Sandbox a fazer chamadas.
  
• Criar uma sandbox com perfis de recursos específicos.
  
• Configurar um Agendador de operações para automatizar o tempo de atividade.
  
• Monitorar o status das instâncias da sua sandbox.
  
• Executar operações de ciclo de vida, incluindo Start (Iniciar), Stop (Interromper), Reset (Redefinir) e Restart (Reiniciar).
  

Assumir o controle do seu ambiente com a API Sandbox do Commerce for B2C

A API Sandbox do Commerce for B2C é uma maneira poderosa de desenvolver e testar soluções do Agentforce Commerce for B2C em um ambiente controlado. A API é usada para criar, gerenciar, configurar e interagir com instâncias de sandbox programaticamente. A API ajuda você a testar integrações, personalizações e novos recursos sem afetar seus sistemas de produção ativos. Use a API Sandbox do Commerce for B2C para interação direta, automação, processos de integração contínua (CI) e entrega contínua (CD) e gerenciamento preciso de recursos.

Acessar e autorizar a API

Antes de poder emitir comandos, você estabelece uma conexão segura autorizando seu acesso.

1. Acesse API REST da sandbox do desenvolvedor do B2C Commerce.
   
2. Clique em Authorize (Autorizar) para iniciar o processo de login.
   
3. Insira a ID de cliente da API configurada no Gerente de conta.
   
4. Clique em Authorize (Autorizar) e em Close (Fechar) para fechar a janela.
   

Após autorizar sua conexão, você poderá fazer chamadas diretamente da interface.

Criar uma sandbox sob demanda

Use o método POST/sandboxes para criar uma sandbox sob demanda para essas especificações:

• emails: email@salesforce.com
  
• TTL: 0
  
• autoScheduled: True (Verdadeiro)
  
• Tags: desenvolvimento de ambiente, engenharia de equipe, projeto ecommerceProj
  
• Start and Stop Scheduler (Iniciar e interromper o agendador): dias da semana de seg a sex
  
• Start time (Hora de início): 08:00:00+03:00
  
• Stop time (Hora da interrupção): 19:00:00Z
  
• analyticesEnabled: false (falso)
  
• Resource profile (Perfil de recursos): Medium (Médio)
  
• Settings OCAPI (Configurações - OCAPI): especifique os recursos para produtos e categorias, respectivamente.
  
• Settings WebDAV (Configurações - WebDAV): especifique caminhos de diretório para cartridges e impex.
  

Veja como criar uma sandbox sob demanda com o métodoPOST/sandboxes.

1. Na API REST da sandbox do desenvolvedor do Commerce for B2C, localize e expanda o método POST/Sandbox.
   
2. Expanda o método POST/sandboxes na seção Sandboxes.
   
3. Preencha o corpo da solicitação conforme as especificações da sandbox. Algumas propriedades são opcionais.
   

{
 "tags": {
   "environment": "development",
   "team": "engineering",
   "project": "ecommerceProj"
 }
}

{
"analyticsEnabled": true
}

"startScheduler": {
    "weekdays": [
      "MONDAY",
      "TUESDAY",
     "WEDNESDAY",
      "THURSDAY",
      "FRIDAY"
    ],
    "time": "08:00:00+03:00"
  },

"stopScheduler": {
    "weekdays": [
      "MONDAY",
      "TUESDAY",
     "WEDNESDAY",
      "THURSDAY",
      "FRIDAY"
    ],
    "time": "19:00:00Z"
  },

json
{
"settings": {
"ocapi": [
{
"client_id": "sample-client-id-12345",
"resources": [
{
"resource_id": "/s/-/dw/data/v20_10/products",
"methods": [
"get",
"post",
"put",
"patch",
"delete"
],
"read_attributes": "(**)",
"write_attributes": "(**)"
},
{
"resource_id": "/s/-/dw/data/v20_10/categories",
"methods": [
"get",
"post",
"put",
"patch",
"delete"
],
"read_attributes": "(**)",
"write_attributes": "(**)"
}
]
}
]
}
}
{
 "settings": {
   "webdav": [
     {
       "client_id": "sample-client-id-12345",
       "permissions": [
         {
           "path": "/cartridges",
           "operations": [
             "read_write"
           ]
         },
         {
           "path": "/impex",
           "operations": [
             "read_write"
           ]
         }
       ]
     }
   ]
 }
}

4. Clique em Execute (Executar) para criar a instância.
   

Gerenciar uma sandbox sob demanda

Para gerenciar com eficácia uma sandbox sob demanda (ODS) do Commerce for B2C, é necessário executar várias operações essenciais para garantir ambientes de desenvolvimento e teste eficientes, uso eficiente de créditos e solução de problemas precisa.

Verificar o status de uma sandbox

Você pode verificar o status de uma sandbox usando o método GET/sandboxes/{sandboxId}, que retorna o estado atual (iniciado, parado ou em atualização). Essa verificação evita a perda de tempo gasto tentando acessar um sistema em carregamento após a criação ou reinicialização de uma sandbox.

Para operações de Start (Iniciar), Stop (Interromper), Reset (Redefinir) e Restart (Reiniciar), use o método POST/sandboxes/{sandboxId}/operations.

• Stop (Interromper): pausa o trabalho e conserva créditos sem excluir a instância.
  
• Start (Iniciar): inicia o trabalho e retoma o consumo de créditos.
  
• Reset (Redefinir): limpa o banco de dados (DBINIT) para um novo conjunto de dados de teste ou recuperação de dados.
  
• Restart (Reiniciar): reinicia a instância e resolve processos bloqueados ou aplica alterações de configuração.
  

Você define a ação no corpo da requisição. Após executar qualquer uma dessas ações, sempre verifique o status da sandbox para confirmar a alteração do estado.

Excluir uma sandbox sob demanda

Para reduzir custos e manter seu realm organizado, exclua ambientes de sandbox obsoletos, como aqueles que permanecem após a mesclagem da ramificação de um recurso ou um ciclo de testes concluído, usando o método de API DELETE/sandboxes/{sandboxId}. Essa ação remove a sandbox de forma permanente, interrompe o consumo de créditos e exclui todos os dados associados. Se você precisar da mesma configuração da sandbox frequentemente, considere automatizar o processo de criação e importação de dados com APIs para que você possa recriar rapidamente o ambiente após a exclusão.

Verificar créditos da sandbox sob demanda

Os gerentes de projeto e administradores monitoram o consumo de recursos para garantir que o orçamento seja cumprido. O monitoramento do uso de créditos ajuda a identificar sandboxes com alto consumo ou picos inesperados na atividade do realm durante períodos específicos.

Para verificar o uso no nível do realm, use o método GET/realm/{realm}/usage, no qual você especifica a ID do realm e as datas de início e término do relatório.

Como alternativa, para isolar o consumo de uma única instância, use o método GET/sandboxes/{sandboxId}/usage, fornecendo a ID da sandbox e as datas de início e término.

Acesse os logs da sandbox sob demanda diretamente pelo Centro de controle

Para diagnosticar problemas de desempenho ou falhas de código rapidamente, acesse os logs da ODS diretamente pelo Centro de controle. Com o Centro de controle, você pode filtrar e pesquisar eventos do servidor sem precisar de URLs separadas ou credenciais de login para cada sandbox.

Não se esqueça do código e dados da loja

Uma nova ODS não contém dados da loja virtual. Você não pode migrar códigos e dados diretamente de uma sandbox baseada em POD para uma ODS. Você pode exportar dados e códigos de uma sandbox baseada em POD e, em seguida, usar a API da ODS para importar dados e códigos para uma ODS.

Recursos

Guia do desenvolvedor do Salesforce: Sandboxes sob demanda