Setup inicial

Após a instalação de um novo ambiente do produto, deverá ser executada a API de Setup.

A API de Setup irá definir automaticamente diversos parâmetros fundamentais para o funcionamento da ferramenta.

A API de Setup:

• Deve ser executada somente em novas instalações, que não possuam dados ainda;

• Pode ser executada somente 1 (uma) vez em cada ambiente;

Exemplos de ferramentas para executar a API:

• cURL

• Insomia

• Postman

Especificação

Dados de entrada

Endpoint

POST https://<raiz da aplicação>/api/internal/services/1.0/setup/5

Body

O corpo da requisição contém um documento JSON conforme exemplo e especificação abaixo.

Exemplo

{
	"sendConfigurationTo":"[email protected]",
	"adminUser": {
		"currentUsername": "admin",
		"name":"Edwards Deming",
		"email": "[email protected]",
		"username":"deming",
		"phone": "1 607 9290292902",
		"sendWelcome": true
	},
	"supportUser": { 
		"email" : "[email protected]" 
	},
	"company": {
		"name": "Zeev"
	},
	"system": {
		"product": "Zeev",
		"alias": "zeev",
		"license":"<codigo da licença>",
		"cloud": true
	},
	"smtp": {
		"host":"smtp.sendgrid.net",
		"user":"sendgriduser",
		"pwd":"sendgridpwd",
		"port": "587"
	},
	"movidesk": {
		"companyId": "129292"
	}
}

Especificação

Propriedade	Tipo	Descrição
sendConfigurationTo	string	Endereço de e-mail que receberá cópia dos dados de criação do ambiente
adminUser.currentUsername	string	Username atual do usuário superadministrador do sistema, o usuário base que vem junto a instalação nova do produto
adminUser.name	string	Novo nome do usuário principal superadministrador
adminUser.email	string	Novo endereço de email do novo usuário principal superadministrador
adminUser.username	string	Novo login do novo usuário principal superadministrador
adminUser.phone	string	Novo telefone do novo usuário principal superadministrador
adminUser.sendWelcome	boolean	Indicativo se deve enviar e-mail ao usuário superadministrador com os dados do ambiente criado
supportUser.email	string	Endereço de e-mail da equipe de infra da SML
company.name	string	Nome da empresa licenciante do sistema
system.product	string	Nome do produto sendo instalado: Zeev
system.alias	string	Nome do dominio escolhido pelo cliente, no caso de instalações na nuvem da SML
system.license	string	Código encriptado de licenciamento do sistema fornecido pela SML
system.cloud	boolean	Indicativo se a instalação é na nuvem da SML
smtp.host	string	Host de servidor de envio de e-mails
smtp.user	string	Usuário para conexão ao host de envio de e-mails
smtp.pwd	string	Senha para conexão ao host de envio de e-mails
smtp.port	string	Porta para conexão ao host de envio de e-mails
movidesk.companyid	int	Id do cliente no Movidesk, plataforma de atendimento da SML

Dados de saída

A API retornará um documento JSON com as seguintes informações:

Propriedade	Tipo	Descrição
users.admin.name	string	Confirmação do novo nome do usuário superadministrador base do sistema
users.admin.email	string	Confirmação do novo endereço de e-mail do usuário superadministrador base do sistema
users.admin.username	string	Confirmação do novo username do superadministrador base do sistema
users.support.username	string	Confirmação do username do usuário de suporte da SML criado
users.support.password	string	Confirmação da senha do usuário de suporte da SML criado
users.service.username	string	Confirmação do username do usuário de serviço criado
users.service.token	string	Confirmação do token de autenticação do usuário de serviço criado (a ser utilizado na configuração do Quartz Service)