Syncari Operations vs Syncari Api Mapping

This article provides a visual mapping between Syncari operations via UI and their corresponding Syncari APIs. As an embed customer, as you onboard new customers, they need to be provisioned and setup in Syncari. The below sections provide a visual image (how to do manually from Syncari UI) and what are their corresponding apis that can be used for automating the entire flow.

Provisioning

Every time you onboard a new customer a new Syncari instance needs to be created. the image shows how this can be done manually from Syncari UI. To automate it, you can call the Syncari Create Instance api. This will give you the unique id for the instance that would be required to call all other subsequent apis.

Create Synapse

The above images show how to create a synapse in Syncari via the UI. To create a synapse via Syncari apis, there are 3 steps involved - 

1. Call the Create Synapse api by passing all the relevant data. This creates the synapse in new status.
2. Call the Test Synapse api to verify all the authentication credentials provided are valid.
3. Call the Activate Synapse api to publish the synapse and make it available to use in pipelines

Create Pipelines

 There are 3 steps involved in creating live pipelines.

1. Create Pipeline - Pipelines can be created using two approaches. One via Quick Starts (template) and another via calling the create pipeline api.
   1. Using Quick Starts - This approach involves installing a Quick Start that was previously created via UI. Call the Install Quick Start api, which would create all the necessary pipelines. To get the Quick Start id, you can call the List Quick Starts api.
   2. Using Create pipeline - Individual pipelines can be created via using the Create Entity pipeline api and Create Field pipeline apis. If the Syncari entity does not exist, you can create the entity using Create Syncari Draft Entity and Publish Syncari Draft Entity apis in that order.
2. Validate Pipeline - Once the pipeline is created in draft mode, validate them to ensure there are no errors. This can be done by calling the Validate Pipeline api.
3. Publish Pipeline - In order to get the pipeline live and syncing data, it has to be published. To do so, call the Publish Pipeline api.