Cloud ERP Resources
Resources
Resources
Resources
In this area, you will find useful information on the integration technology for Jasmin and ROSE, as well as help guides with simple and practical examples on how to start developing a solution. You will also find information on all Web API aspects necessary for developing applications, from reference topics to more advanced features.
Cloud ERP API Documentation
API Documentation
API Documentation
API Documentation
API is how third-party apps access the cloud products Jasmin and ROSE and can be used for a variety of operations, for example, creating transactions such as invoices or credit notes, and exploring the information using the data list.
Cloud ERP Zapier
Zapier
Zapier
Cloud ERP Zapier
Zapier
Zapier
How to use Zapier to integrate with other apps?
Last changed in 20/07/2021

The Web API allows you to build integrations with other solutions that, when combined with it, allow you to make a truly integrated information system that works for Jasmin and ROSE customers.

The following are examples only applicable to Jasmin.

In the Jasmin MarketPlace you can find solutions integrated into Jasmin that have undergone a certification process to ensure the quality of the solutions and their integration with Jasmin.

This integration can be point-to-point (direct between two applications) or take make use of an integration platform. The second option, in addition to facilitating the interface between different applications, generally does not require programming knowledge on the part of users, with the tradeoff that they usually offer fewer integration options.

The following are examples of integrations of third-party solutions with Jasmin.

Integration with Salesforce via Zapier

Salesforce is a leading CRM solution for enterprises. This family of products and services, built around the Salesforce platform, allows you to manage the areas of marketing, sales, and services.

Features:

  • Customizable fields to track anything the user needs;
  • Dashboards, analyses, and reports to interpret user data;
  • Full integration of email features;
  • Possibility to use Chatter to keep in touch with the whole team;
  • Native iOS and Android applications and integration with Microsoft Outlook.

Zapier allows you to make web applications interface with each other and automate workflows.

  • When adding/updating a customer in Jasmin - add/update a contact in Salesforce;
  • When adding/updating a contact in Salesforce - add/update a customer in Jasmin;
  • When adding/updating a contact in Salesforce - add/update a customer in Jasmin;
  • When adding/updating material in Jasmin - add/update material in Salesforce;
  • When adding/updating an opportunity in Salesforce - add/update an order in Jasmin.

Integration with Magento via Zapier

Magento is the open-source eCommerce application used by millions of customers every day.

Features:

  • Create promotions and products, inventory and sales management;
  • Monitor each customer and order and adding notes to transactions made;
  • Send newsletters via email;
  • Build detailed sales reports;
  • Access extra features with Magento extensions.

Zapier allows you to make web applications interface with each other and automate workflows. This integration allows you to automate the following workflows:

  • Add a customer in Magento when a customer is added in Jasmin;
  • Add an article in Magento when an article is added in Jasmin;
  • Add/update a customer in Jasmin when a customer is added to Magento;
  • When a sale is completed in Magento: (1) add an invoice/receipt in Jasmin; (2) add/update a customer in Jasmin.

Integration with WooCommerce by Willbe

WooCommerce is a WordPress eCommerce plugin that turns a WordPress site into a fully featured eCommerce store.

Features:

  • Create an online store in WordPress within minutes;
  • Sell physical and digital products to customers all over the world;
  • Create, edit and manage products and orders directly from the dashboard;
  • Receive email notifications for products that are out of stock, below a minimum stock level, etc.;
  • Product, taxes, shipping, transaction email, and customer account settings;
  • Self-hosted platform that allows you to maintain and protect business data in any situation.

The integration between Jasmin and WooCommerce allows you to coordinate operations between these, avoiding repeating tasks and automating information flows, which allow:

  • When adding/updating a client in Jasmin - add/update a client in WooCommerce;
  • When adding/updating an article in Jasmin - add/update an article in WooCommerce;
  • When adding/updating a client in WooCommerce - add/update a customer in Jasmin;
  • When a sale is completed in WooCommerce: (1) add an invoice/receipt in Jasmin; (2) add/update a customer in Jasmin.
Bookmark or share this article
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? Como utilizar o Zapier para integrar com outras aplicações?
Cloud ERP Postman
Postman
Postman
Cloud ERP ResourcesGuides
ResourcesGuides
Guides
Voltar | Lista de artigos
How to execute OData queries on data?
Última alteração a 15/10/2021

What is OData?

OData (Open Data Protocol) is a standard protocol that allows data creation and consumption using a Web API.

It is a standard built on HTTP and REST protocols, and that supports CRUD operations on the entities available on the Web API.

Given its characteristics, this protocol is particularly useful to execute ad-hoc queries on that data.

More info: http://www.odata.org/

OData

The OData services available in Jasmin allow viewing Jasmin's entities from external apps, for example, its attributes, the corresponding values, and the related entities.

OData allows to perform a more agile and customized consultation, considering that it allows using the parameters to get the desired results.

Parameters for OData consultations

OData consultations are simply the execution of GET actions on the Web API, with certain parameters that condition the results.

Next, we present the parameters that can be used in OData consultations, as well as examples of its application on Jasmin's Web API.

Tip: Every time properties are referenced in OData expressions, the Pascal Case convention must be used (first letter if each word in uppercase)

$TOP

Allows to define the number of desired results.

Example:

To get the first 5 results from the sales item list:

http://my.jasminsoftware.com/api/{account}/{subscription}/salescore/salesitems/odata?$top=5

$SKIP

Allows to ignore the N first results of a query.

Example:

To get 5 records from the sales item list, ignoring the first 5:

http://my.jasminsoftware.com/api/{account}/{subscription}/salescore/salesitems/odata?$skip=5

$INLINECOUNT

Allows to include a record totalizer on the query results.

Example:

To get the total of records existent in the sales item list:

http://my.jasminsoftware.com/api/{account}/{subscription}/salescore/salesitems/odata?$inlinecount=allpages

$ORDERBY

Allows to order, in ascending or descending order, the results for one or more attributes.

Example:

To get the existent records in the sales item list, by ordering by attribute "ItemKey" in descending order:

http://my.jasminsoftware.com/api/{account}/{subscription}/salescore/salesitems/odata?$orderby=ItemKey desc

$SELECT

Allows to select the attributes to be presented on the results returned by the query.

Example:

To get the attributes "ItemKey" and "Description" from the existent records on the sales item list:

http://my.jasminsoftware.com/api/{account}/{subscription}/salescore/salesitems/odata?$select=ItemKey,Description

$EXPAND

Allows to expand the consultation to entities related with the search entity, for example, when you wish to select a detail's attribute. This parameter can only be used associated to the $SELECT parameter.

Example:

To get the attributes "ItemKey" and "Description" from the existent records on the sales item list and the attribute "PriceAmountAmount" from the details:

http://my.jasminsoftware.com/api/{account}/{subscription}/salescore/salesitems/odata?$select=ItemKey,Description,PriceListLines/PriceAmountAmount&$expand=PriceListLines

$FILTER

Allows to filter the results based in certain conditions, namely, the followings:

EQ (Equal)

To get the records in which the attribute "ItemKey" is equal to "PORTES":

http://my.jasminsoftware.com/api/{account}/{subscription}/salescore/salesitems/odata?$filter= ItemKey eq 'PORTES'

AND

To get the records in which the attribute "ItemKey" is equal to "PORTES" and the attribute "Unit" is equal to "UN":

http://my.jasminsoftware.com/api/{account}/{subscription}/salescore/salesitems/odata?$filter= ItemKey eq 'PORTES' and Unit eq 'UN'

OR

To get the records in which the attribute "Unit"is equal to "UN" or "KG":

http://my.jasminsoftware.com/api/{account}/{subscription}/salescore/salesitems/odata?$filter= Unit eq 'UN' or Unit eq 'KG'

LT (LESS THAN)

To get the records in which the attribute "ItemKey" is less than "0010":

http://my.jasminsoftware.com/api/{account}/{subscription}/salescore/salesitems/odata?$filter= ItemKey lt '0010'

GT (GREATER THAN)

To get the records in which the attribute "ItemKey" is greater than "0010":

http://my.jasminsoftware.com/api/{account}/{subscription}/salescore/salesitems/odata?$filter= ItemKey gt '0010'

GE (GREATER THAN OR EQUAL TO)

To get the records in which the attribute "ItemKey" is greater than or equal to "0010":

http://my.jasminsoftware.com/api/{account}/{subscription}/salescore/salesitems/odata?$filter= ItemKey ge '0010'

LE (LESS THAN OR EQUAL TO)

To get the records in which the attribute "ItemKey" is less than or equal to "0010":

http://my.jasminsoftware.com/api/{account}/{subscription}/salescore/salesitems/odata?$filter= ItemKey le '0010'

STARTWITH

To get the records in which the attribute "ItemKey" starts with "POR":

http://my.jasminsoftware.com/api/{account}/{subscription}/salescore/salesitems/odata?$filter= startswith(ItemKey , 'POR')

SUBSTRINGOF

To get the records in which the value ‘cadeira’ is part of the string for attribute "Description":

http://my.jasminsoftware.com/api/{account}/{subscr

Parameters combination

The parameters mentioned previously can be combined to streamline searches. Next, we present a few practical examples.

Example:

To get the attributes "CustomerPartyName" and "SeriesNumber" for the records on the orders list, in descending order by the attribute "SeriesNumber", as well as the counter of records that match the search criteria:

http://my.jasminsoftware.com/api/{account}/{subscription}/sales/orders/odata?$inlinecount=allpages&$select=BuyerCustomerPartyName,SeriesNumber&$orderby=SeriesNumber desc

To get the attributes "BuyerCustomerPartyName" and "PayableAmountAmount" for the 10 orders with the highest value, presented from the highest value to the lowest value, as well as the counter of records that match the search criteria:

http://my.jasminsoftware.com/api/{account}/{subscription}/sales/orders/odata?$inlinecount=allpages&$select=BuyerCustomerPartyName,PayableAmountAmount&$top=10&$orderby=PayableAmountAmount desc
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 OData para obter uma lista de encomendas? Como obter uma lista de encomendas? Como criar uma encomenda de vendas? Como executar queries OData sobre os dados? Como utilizar OData para obter uma lista de encomendas?