Cloud ERP Recursos
Recursos
Recursos
Recursos
Nesta área encontra informações sobre a tecnologia de integração para o Jasmin e ROSE, bem como guias de ajuda com exemplos simples e práticos sobre como iniciar o desenvolvimento de uma solução. Também encontra informações sobre todos os aspetos da Web API necessários ao desenvolvimento de aplicações, desde tópicos de referência até funcionalidades mais avançadas.
Cloud ERP Documentação API
Documentação API
Documentação API
Documentação API
A API é a forma como aplicações terceiras podem aceder aos produtos cloud Jasmin e ROSE e pode ser usada para uma variedade de operações, como por exemplo a criação de transações como faturas ou notas de crédito, até a exploração de informação através de listagem de dados.
Cloud ERP Zapier
Zapier
Zapier
Cloud ERP Zapier
Zapier
Zapier

Como utilizar o Zapier para integrar com outras aplicações?

Última alteração a 27/09/2021

A Web API permite construir integrações com outras soluções que, em combinação com os produtos cloud, permitem colocar um verdadeiro sistema integrado de informação ao serviço dos clientes Jasmin e ROSE.

Os exemplos apresentados aplicam-se nesta fase apenas ao Jasmin.

No Jasmin MarketPlace é possível encontrar soluções integradas com o Jasmin que passaram por um processo de certificação para garantir a qualidade das soluções e da sua integração com o Jasmin.

Esta integração pode ser ponto-a-ponto (direta entre duas aplicações) ou tirar partido de uma plataforma de integração. Estas últimas, para além de facilitarem a tarefa de interligação entre diversas aplicações não requerem geralmente conhecimentos de programação por parte dos utilizadores apesar de oferecerem menos opções ao nível da integração.

Seguem-se alguns exemplos de integrações de soluções terceiras com Jasmin.

Integração com Salesforce via Zapier

O Salesforce é uma solução líder de CRM para empresas. Esta família de produtos e serviços, construídos em torno da plataforma Salesforce, permite gerir as áreas de marketing, vendas e serviços.

Funcionalidades:

  • Campos personalizáveis para rastrear qualquer coisa que o utilizador necessite;
  • Dashboards, análises e relatórios para dar sentido aos dados dos utilizadores;
  • Integração completa de funcionalidades de email;
  • Possibilidade de usar o Chatter para se manter contato com toda a equipa;
  • Aplicações nativas para iOS e Android e integração com o Microsoft Outlook.

O Zapier permite fazer com que as aplicações Web falem umas com as outras e automatizar fluxos de trabalho.

  • Ao adicionar/atualizar um cliente no Jasmin - adicionar/atualizar um contacto no Salesforce;
  • Ao adicionar/atualizar um contacto no Salesforce - adicionar/atualizar um cliente no Jasmin;
  • Ao adicionar/atualizar um contacto no Salesforce - adicionar/atualizar um cliente no Jasmin;
  • Ao adicionar/atualizar um artigo no Jasmin - adicionar/atualizar um item no Salesforce;
  • Ao adicionar/atualizar oportunidade no Salesforce - adicionar/atualizar uma encomenda no Jasmin.

Integração com Magento via Zapier

O Magento é a aplicação open-source de e-commerce usado por milhões de clientes todos os dias.

Funcionalidades:

  • Criação de promoções e produtos, controle o inventário e gestão de vendas;
  • Acompanhamento de cada cliente e de cada encomenda e registo de anotações sobre as transações realizadas;
  • Envio de newsletters via email;
  • Construção de relatórios detalhados sobre vendas;
  • Acesso a funcionalidades extras com as extensões ao Magento.

O Zapier permite fazer com que as aplicações Web falem umas com as outras e automatizar fluxos de trabalho. Esta integração permite automatizar os seguintes fluxos de trabalho:

  • Adicionar um cliente no Magento ao adicionar um cliente no Jasmin;
  • Adicionar um artigo no Magento ao adicionar um artigo no Jasmin;
  • Adicionar / atualizar um cliente no Jasmin ao adicionar um cliente no Magento;
  • Ao completar uma venda no Magento: (1) adicionar uma fatura/recibo no Jasmin; (2) adicionar/atualizar um cliente no Jasmin.

Integração com WooCommerce by Willbe

WooCommerce é um plugin WordPress para eCommerce que transforma o um site WordPress numa loja de eCommerce totalmente caracterizada.

Funcionalidades:

  • Criação de uma loja on-line em minutos dentro do WordPress;
  • Venda de produtos físicos e digitais a clientes em todo o mundo;
  • Criação, edição e gestão de produtos e pedidos diretamente do painel de controlo;
  • Receção de notificações por email para os produtos sem stock, abaixo de um valor de stock mínimo, etc.;
  • Configurações de produtos, impostos, envio, emails transacionais e contas de clientes;
  • Plataforma auto-hosted que permite manter e proteger os dados do negócio em qualquer situação.

A integração entre o Jasmin e o WooCommerce permite coordenar operações entre as duas soluções evitando a duplicação de tarefas automatizando os fluxos de informação que permitem:

  • Ao adicionar/atualizar um cliente no Jasmin - adicionar/atualizar um cliente no WooCommerce;
  • Ao adicionar / atualizar um artigo no Jasmin - adicionar/atualizar um artigo no WooCommerce;
  • Ao adicionar/atualizar um cliente no WooCommerce - Ao adicionar / atualizar um cliente no Jasmin;
  • Ao completar uma venda no WooCommerce: (1) adicionar uma fatura/recibo no Jasmin; (2) adicionar/atualizar um cliente no Jasmin.
Adicionar aos favoritos ou partilhar este artigo
Esta página foi útil?
Obrigado pelo seu voto.
login para deixar a sua opinião.
O que podemos fazer para melhorar esta página? (opcional)
Caminho errado
Informação insuficiente
Leitura difícil
O link não funciona
Precisa de infografia ou de vídeo
Comentários
Obrigado pelo seu feedback. Iremos analisá-lo para continuarmos a melhorar!
Artigos Relacionados
Como utilizar o Zapier para integrar com outras aplicações?
Cloud ERP Postman
Postman
Postman
Cloud ERP Postman
Postman
Postman

POSTMAN

Última alteração a 27/09/2021

O postman permite testar os endpoints dos produtos cloud como o ROSE e o JASMIN, para isso, podes fazer download através dos botões abaixo ou em alternativa fazer fork dos coleções através dos workspaces disponiveis em postman.com/primaverabss-developers

Registo da Aplicação

Se ainda não tens uma entidade PRIMAVERA, começa por registar-te aqui e criar a tua App. Depois de criares a tua App, tens de autorizar o acesso a uma subscrição.

  1. Para autorizar, edita a tua App.
  2. Seleciona o menu Autorização.
  3. Carrega no link Ligação de Pré-visualização da App Store.
  4. Carrega no botão Adicionar e seleciona a subscrição.

Instalar a coleção

Clique no botão abaixo para instalar a coleção do Postman para o ROSE.

Clique no botão abaixo para instalar a coleção do Postman para o JASMIN

Configurar Autenticação

O ROSE e JASMIN usam segurança OAuth 2.0, assim a primeira coisa a fazer antes de utilizar a coleção no postman é configurar a forma como este cliente se vai autenticar junto do produto.

  1. No Postman, selecione o menu Collections.
  2. Selecione a pasta "ROSE API Collection" ou "JASMIN API Collection".
  3. Selecione o separador Authorization.
  4. Na combobox Type, selecione OAuth 2.0.
  5. Na combobox Add authorization data, selecione Request Headers.
  6. Na secção Configure New Access Token, introduza a informação abaixo.
ATRIBUTOINFORMAÇÃO
Token NameO nome do token a utilizar.
Grant TypeSelecionar Authorization Code ou Implicit. Isto depende o tipo de acesso selecionado no registo da tua app.
Callback URLUsar https://www.getpostman.com/oauth2/callback
Auth URLUsar https://identity.primaverabss.com/connect/authorize
Access Token URLUsar https://identity.primaverabss.com/connect/token
Client IDUsar o valor do campo Chave que está na tua app.
Client SecretUsar o segredo gerado no registo da tua app. Este campo não está disponivel se o grant type for Implicit.
ScopeUsar rose-api para o ROSE e application para o JASMIN.
Client Authentication
Usar  Send as Basic Auth header.

Variáveis

Para a coleção funcionar, é necessário dar contexto sobre a subscrição a usar.

  1. No Postman, selecione o menu Collections.
  2. Selecione a pasta "ROSE API Collection" ou "JASMIN API Collection".
  3. Selecione o separador Variables.
VARIÁVEISVALOR
BaseUrlUsar https://app.rose.primaverabss.com/ para o ROSE e https://my.jasminsoftware.com/ para JASMIN
AccountKey/TenantEste valor pode ser obtido do url depois de entrar na aplicação no parâmetro ?account.
SubscriptionKey/OrganizationEste valor pode ser obtido do url depois de entrar na aplicação no parâmetro ?subscription
CompanyKeyCódigo da empresa. Esta variável é usada para as entidades que estão associadas a uma empresa, como por exemplo as faturas.
Adicionar aos favoritos ou partilhar este artigo
Esta página foi útil?
Obrigado pelo seu voto.
login para deixar a sua opinião.
O que podemos fazer para melhorar esta página? (opcional)
Caminho errado
Informação insuficiente
Leitura difícil
O link não funciona
Precisa de infografia ou de vídeo
Comentários
Obrigado pelo seu feedback. Iremos analisá-lo para continuarmos a melhorar!
Artigos Relacionados
POSTMAN
Cloud ERP RecursosRegisto de Aplicações
RecursosRegisto de Aplicações
Registo de Aplicações

Gestão das aplicações integradas

Última alteração a 27/09/2021

O sistema de autenticação de utilizadores e de segurança dos produtos requer que todas as aplicações integradas sejam registadas no sistema. Essa informação é utilizada no acesso à Web API para assegurar o acesso aos dados da subscrição de um determinado cliente.O registo da aplicação permite ao programador ter acesso ao token de autorização que deve ser utilizado em todas as chamadas à Web API.

A Web API utiliza o standard OAuth 2.0 para autorizar o acesso às subscrições e por consequência aos dados. Encontra-se disponível uma área que permite gerir o registo das suas aplicações de integração para programadores de aplicações de integração.

Para mais informações sobre o OAuth 2.0, sugere-se a consulta do seguinte artigo:

Registo de aplicações

O registo de aplicações encontra-se disponível na App Store que se encontra dividida em três áreas:

  • App Store;
  • Developer;
  • Subscription Apps.

Área do Developer

Esta área está dividida em duas subáreas: Dashboard e Publisher.

Publisher

Nesta subárea é apresentada a lista de publishers associada à conta de utilizador, sendo permitido adicionar e remover publishers.

Para adicionar um novo publisher basta clicar no Create Publisher na área Publisher e indicar os seguintes dados:

  • Key: identificador do publisher;
  • Name: o nome público do publisher;
  • Description: descrição do publisher.

Dashboard

Nesta subárea é permitido consultar, editar, publicar ou remover aplicações, bem como criar ou remover subscrições para testes.

1) Adicionar nova aplicação

Para adicionar uma nova aplicação, siga os seguintes passos:

  1. Clicar no Creat App na área Dashboard;
  2. Inserir os seguintes dados sobre a aplicação:
    - Product: nome do produto;
    - Key: identificador da aplicação (chave/clienteId que será usada nas aplicações integradoras);
    - Name: o nome público da aplicação;
    - Description: descrição da aplicação;
  3. Depois de confirmar, é redirecionado para a página de configuração da aplicação onde terá que preencher todos os dados necessários.

Esta página de configuração está dividida em seis áreas, sendo necessário preencher as seguintes informações:

General:

Deverá preencher os seguintes campos:

  • Product: nome do produto;
  • Version: versão da aplicação;
  • Name: nome público da aplicação;
  • Key: identificador da aplicação;
  • Publisher Key: identificador do publisher;
  • Home Page: o endereço Web da aplicação (para efeitos informativos);
  • Description: descrição da aplicação.

Logo & Images:

Nesta área deverá indicar o logótipo da aplicação para efeitos informativos.

Autorization

Deverá inserir os seguintes dados:

  • OAuthFlow: fluxo de autenticação que pode ser de 4 tipos - ImplicitHybrid, Client Credencials e Authorization Code;
  • Redirect URI: o endereço da página que será utilizada na autorização (ver documentação sobre autorização).

Ao selecionar os tipos de fluxo Client Credentials ou AuthorizationCode, deverá gerar um Client Secret no botão disponível para o efeito, sendo necessário gravar a aplicação após alteração do fluxo.  Para obter o token que autoriza as chamadas à API é necessário possuir a chave da aplicação e o secret. Não é possível recuperar esta informação, por isso deverá guardá-la de forma segura. Contudo, é possível gerar um novo Client Secret através da opção Reset Client Secret.

Additional Settings

Deverá preencher os seguintes dados:

  • App Store Preview Link: o link do preview da aplicação na store. Pode ser utilizado para subscrever a aplicação sem efetuar a publicação da mesma;
  • Notifications Endpoint: o endpoint para o envio de notificações para a aplicação;
  • External Subscription Url: a Url externa de redireccionamento para a aplicação.

Distribution

Após preencher todos os requisitos necessários, é possível submeter a aplicação para aprovação através da opção Submit for approval. Será também apresentado o estado em que se encontra a aprovação da aplicação.

Delete App

Poderá remover a aplicação da App Directory através da opção Delete App.

2) Editar o registo de uma aplicação

É possível editar as aplicações depois de as criar, exceto os campos:

  • Product;
  • Name;
  • Key.

Poderá também efetuar o publish ou unpublish de aplicações, bem como solicitar a geração de novo Client Secret (esta opção apenas se encontra disponível para aplicações com os tipos de autenticação Client Credentials ou AuthorizationCode).

3) Efetuar publish/unpublish de uma aplicação

Ao efetuar o publish, está a permitir que a aplicação fique visível na App Store do Jasmin e, assim, qualquer utilizador pode subscrevê-la e utilizá-la nas suas subscrições. Por outro lado, ao efetuar o unpublish, esta deixa de estar visível na App Store. No entanto, independentemente do unpublish, as aplicações podem continuar a ser utilizadas nas subscrições que a tenham associado previamente.

Nota: Estas funcionalidades apenas se encontram disponíveis na edição de uma aplicação e na listagem de aplicações, no botão associado.

4) Subscrever uma aplicação sem a publicar

Poderá utilizar ou partilhar o link de preview para visualizar o aspeto da aplicação na store, bem como para efetuar a subscrição da app para efeitos de teste ou para a manter como privada.

5) Criar uma nova subscrição para efeitos de desenvolvimento

Para que o desenvolvimento de uma aplicação integrada não interfira com as contas reais dos clientes, é possível criar uma subscrição de desenvolvimento que poderá utilizar para este efeito.

Em termos funcionais e de dados iniciais, este tipo de subscrição é idêntica a uma subscrição DEMO. Este tipo de subscrição permite experimentar livremente o produto durante 30 dias com dados fictícios.

Se uma subscrição de desenvolvimento expirar, o developer poderá sempre criar uma nova, sendo que perderá todos os dados inseridos na subscrição anterior. De referir que só poderá criar três subscrições.

6) Remover subscrição

Ao remover uma subscrição, esta deixa imediatamente de estar disponível na área de Manager.

Subscribed Apps

1) Associar uma aplicação a uma subscrição

Ao associar uma aplicação a uma subscrição está a permitir que esta seja utilizada na subscrição.

Para associar a sua aplicação, siga os seguintes passos:

  1. Selecionar a aplicação da lista de aplicações disponíveis;
  2. Selecionar a opção Subscribe e, posteriormente, a subscrição pretendida;
  3. Clicar em Confirmar.

2) Remover uma aplicação de uma subscrição

Ao remover uma aplicação de uma subscrição, deixa de ser possível utilizar a aplicação nessa subscrição.

Adicionar aos favoritos ou partilhar este artigo
Esta página foi útil?
Obrigado pelo seu voto.
login para deixar a sua opinião.
O que podemos fazer para melhorar esta página? (opcional)
Caminho errado
Informação insuficiente
Leitura difícil
O link não funciona
Precisa de infografia ou de vídeo
Comentários
Obrigado pelo seu feedback. Iremos analisá-lo para continuarmos a melhorar!
Artigos Relacionados
Gestão das aplicações integradas