Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Product_title
TitleGetting started
Image<>


Este guia explica como configurar seu ambiente para desenvolvimento usando a biblioteca @totvs/Mingle.

A biblioteca Mingle realiza a integração transparente com o servidor do Mingle que esta na nuvem, assim o desenvolvedor não precisa se preocupar com o servidor do Mingle. 

O guia Getting Started inclui informações sobre:

  • Pré-requisitos
  • Cadastro na plataforma Mingle
  • Instalação do pacote Mingle Client
  • Configuração da ferramenta para cada ambiente
  • Criação de um aplicativo inicial e a execução local desse aplicativo para verificar sua configuração.

Seguindo o passo a passo apresentado nos próximos tópicos o desenvolvedor terá um software integrado com a biblioteca Mingle e estará pronto para desenvolver uma aplicação de alta performance.


Expandir
title1- Pré-requisitos

Para começar a utilizar o a biblioteca @totvs/mingle em sua aplicação é necessário possuir: 


Aviso

Para aplicações desenvolvidas com o framework IONIC: 

Você deve executar a instalação dos plugins MIngle-ionic: Mingle Ionic Geolocation Mingle Ionic Device.

Consulte a documentação Pacote @totvs/mingle na plataforma Ionic para maiores detalhes.

Informações

Este guia utiliza o framework Angular para os seus exemplos.

A biblioteca @totvs/mingle é compatível com os frameworks que são baseados no javascript.


Expandir
title2- Criando um projeto do zero

A biblioteca Mingle foi criada para facilitar a comunicação entre os aplicativos e o servidor Mingle. 

Com ela nós teremos a facilidade de realizar login com poucas linhas de código, recursos para geração de métricas, interceptadores de requests entre outros diversos métodos públicos que facilitarão o trabalho do programador.

Instalação do pacote Mingle

Para começar a utilizar o Mingle o primeiro passo é fazer a instalação usando o npm: 

$ npm install --save @totvs/mingle


Acompanhe as próximas páginas deste guia para iniciar o desenvolvimento utilizando o pacote instalado.


Expandir
title3- Configurações iniciais

Neste passo vamos realizar a configuração da classe MingleService que deverá ser instanciada no início da sua aplicação para que possamos tirar proveito de todas as funcionalidades da biblioteca Mingle em seu aplicativo. 

Consideramos este passo o mais importante, aqui é onde iremos configurar uma única instância da classe MingleService e ela funcionará por toda a sua aplicação. 

Utilizando o comando $ "ng generate service appinitservice"

 do

do Angular CLI, criamos um serviço AppInitService e nele realizamos a seguinte implementação: 

Bloco de código
languagejs
firstline1
titleappInitService
linenumberstrue
import { Injectable } from '@angular/core';
import { MingleService } from '@totvs/mingle';
@Injectable()
export class AppInitService {
  
 constructor(private mingleService: MingleService) { }
  
 mingleConfiguration(): Promise<any> {
   return new Promise((resolve, reject) => {      
     console.log("Mingle Service Configuration called");
     const server = mingleService.servers.development;
     const appId = 'your_app_id';
     const web = true;
 
     this.mingleService.init(server, appId, web)
      .then( init => {
       resolve('Mingle Service Init');
     }).catch(error => {
       console.log("error" , error);
       
       reject(error);
     }); 
    console.log("Mingle Service configuration completed"); 
   });
 }}

Agora vamos analisar os trechos mais importantes do código acima:

Realize a importação da classe MingleService.

Bloco de código
languagejs
titleappInitService
import { MingleService } from '@totvs/mingle';

Deverão ser passados três parâmetros para a inicialização do Mingle (init):

O primeiro parâmetro que deverá ser passado é o servidor. 

Existem três servidores, sendo eles: 

  1. Development = 'https://dev-mingle.totvs.com.br/api'
  2. Staging = 'https://hom-mingle.totvs.com.br/api'
  3. Production = 'https://mingle.totvs.com.br/api'

Como neste exemplo ainda estamos desenvolvendo, vamos utilizar o ambiente "Mingle Development": 

  • server = this.mingleService.servers.development;

Para utilizar o ambiente Staging

  • server =  this.mingleService.servers.staging;

Para utilizar o ambiente Production

  • server =  this.mingleService.servers.production;

O segundo parâmetro que deverá ser utilizado é o appId. Cada ambiente possui um appId por aplicativo, o appId deve ser solicitado para um membro da equipe do Mingle.

O terceiro parâmetro deverá ser a plataforma utilizada.

  • Em aplicações web utilize: web = true; 
  • Em aplicações mobile utilize: web = false; a biblioteca enviará o deviceID e a plataforma do mobile para o registro de métricas e gateways do Mingle Server. 

Em seguida inicie o aplicativo utilizando o método init() da classe mingleService, informando os três parâmetros acima descritos:

Bloco de código
languagejs
firstline1
titleappInitService
linenumberstrue
this.mingleService.init(server, appId, web)
   .then( init => {
    resolve('Mingle Service Init');
})

Agora que você realizou a configuração Mingle e o método init() já está pronto, vamos dizer para o seu aplicativo utilizar a classe AppInitService quando for compilado e iniciado.

Adicione o bloco de código abaixo em seu app.module.ts (pode ser logo após os imports ou então se for de sua preferência pode ser uma função importada de um arquivo externo).

Bloco de código
languagejs
firstline1
titleapp.module.ts
linenumberstrue
export function initializeApp1(appInitService: AppInitService) {
  return (): Promise<any> => {
    return appInitService.mingleConfiguration();
  }
}

No app.module.ts -> Providers: 

 1- Declare  AppInitService e MingleService

 2- Crie um provide para realizar o APP_INITIALIZER que será responsável por executar as configurações realizadas no tópico anterior

3- Realize a importação das classes declaradas em providers

Bloco de código
languagejs
firstline1
titleappInitService
linenumberstrue
providers: [
  AppInitService,
  MingleService,
  { provide: APP_INITIALIZER, useFactory: initializeApp1, deps:[AppInitService], multi: true}
],

Agora basta compilar a aplicação e acompanhar o terminal de logs.

Para essa aplicação utilizamos o comando:  $ "ng serve"

Em caso de compilação e configuração positiva, sem erros, no console do seu navegador será apresentada a mensagem:  "Mingle Service configuration completed".

Acompanhe os próximos tópicos desta documentação para começar a desenvolver a aplicação utilizando o Mingle, como por exemplo realizar uma autenticação ou uma requisição de API  utilizando a segurança que o gateway do Mingle proporciona.

HTML
<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}
</style>


Expandir
title4- Autenticação