[Deprecated] How does the Data Sharing work

Deprecated section

This section of our wiki is deprecated. You landed here because we developed new better tools to integrate with Maestrano and our Partners. We now have a brand new Developer Platform which simplifies a lot your integration on all our Partner Marketplaces (both to manage marketing listing and to manage your technical integration).

If your application is already integrated with Maestrano, do not panic! Your integration still works perfectly. To simplify your journey with us and our partner's marketplaces, we will onboard you soon on the developer platform. If you want to know more, just send us an email (developers@maestrano.com), nothing to be afraid of (smile)

What is the Data Sharing?

Data-sharing is the capability of pushing and pulling information in real time from one application to another application. Instead of mapping from one app to another app the necessary workflows, our Data-Sharing is defined by Object data management where the end-user doesn't end up having to define the workflows he or she wants when syncing apps together. Everything is defined during the integration process of our app partners:

When the SSO process is triggered, a group_id is given to you and can be used along with your application credentials (API keys) to start accessing the Connec! API. At this point of time you can start pulling relevant data from the API into your application.

When the user create or update information in your application, notifications should be sent to Connec! that will take care of propagating these to other applications the user owns on the Maestrano platform. On the other side, whenever the user create or update information in another application, if you subscribed to the appropriate webhooks, you will receive notifications that will allow you to create or update information in your application.

How to implement the data sharing part?

You have two possibilities:

1 If you have a public API

We strongly recommend you to use our Connector framework in Ruby on Rails, which will allow you to connect our API with yours, without messing with your code! Have a look at our Connector framework documentation and at Connec! documentation to understand how to connect our APIs.

The main differences are related to data-sharing implementation:

The typical SDK integration is intrusive in the sense that application providers have to modify their application to include our SDK and send requests to our APIs on user interactions. With the connector approach, it acts as a bridge between the Connec! and the Application APIs so data-sharing is no longer implemented by the application but by the connector itself.

Benefits of using the connector:

    • Not intrusive (runs outside of the application)
    • Separate development life cycle (app providers do not need to release their application every time they update the data-sharing) 
    • Already implements logic for initial data import, Connec! webhooks for real-time updates
    • Support basic configuration (enable/disable data-sharing, select entities to share)
    • Development of the connector can be outsourced as the application code is not exposed (Maestrano can propose services for implementing it) Hosted on the cloud (Maestrano can provide support for hosting connectors)

2 If you don't

Just have a look at Connec! documentation to learn how to use our public API!