This is designed to be used by an MiSP or someone who is familiar with making API calls and Postman.
Background
For data coming TO iPaaS.com, the system is notified about new data to pull in via a webhook. That webhook creates an entry in the queue which is then processed as it gets to the top of the queue. Processing it involves making a GET call to the source system and based on the scope (create, update, delete, etc) and the mapping collection(s), that data is normalized into iPaaS.com data models. Once that piece of data has been created/updated in iPaaS.com, any systems that are listening to changes in that data type will have the record queued up and the same process will occur to push the data out to those systems.
A manual sync operation does the same thing by inserting a record into the queue manually. If you run that operation in debug mode it does the same thing, but also pushes it to the top of the queue and produces additional logging.
The above process is the same for a system that uses polling, it just adds the IDs it pulls in during the poll to the queue.
The manual sync page allows you to add up to 3,000 IDs, but sometimes you will need to seed an entire product catalog or move historical orders. The following will show you how you can use the Potman Runner functionality to add a series of IDs to iPaaS.com to send them as hooks.
Before you move forward here:
If you need to move data TO iPaaS.com and the integration uses polling, you can use the manual sync and a /poll scope to pull in all data.
If the data type / direction supports initialization you can use that feature as well.
Setting up your Data
Data TO iPaaS.com
You will need to obtain a list of all of the IDs of the records to pull them in (either via an export from that system or using their API). Please ensure you use the external ID format that iPaaS.com is looking for per that subscription's documentation.
Data FROM iPaaS.com
Remember that TO iPaaS.com hooks will then result in FROM iPaaS.com hooks, so this is only relevant for when you only need to sync from iPaaS.com to one system.
You will need to use the iPaaS.com API to pull the record IDs you need and parse them out of the JSON response.
Finding the Scope to Use
The scopes supported for an integration and piece of data can be found on the outbound/inbound data flows page in the subscription settings or on the manual sync page.
Setting up the CSV
The CSV just needs to have 2 columns, ID and Scope. If all of the scopes are the same for the sync you are performing, you do not have to use the scope parameter, but you can.
Example:
id,scope
12345,product/create
45671,customer/update
Setting Up Postman
Authentication
For authentication, you will use the webhook API key from the subscription as that is what authenticates this endpoint. To locate this, go to subscription management > Subscriptions > Settings for the subscription you want to sync from or to.
Call
You will be making a call to /v2/iPaaS. You can find the swagger page for that here. The root URL is:
Staging:
https://stagingapi.ipaas.comProduction:
https://api.ipaas.com
Setting up the Runner
Create the call in Postman
For a TO iPaaS.com hook:
For a FROM iPaaS.com hook:
Click on File>New Runner Tab
Drag in the collection you want to use
Set your variables (i.e.
{{id}}and{{scope}})Import your file
Set the bearer token if you have not already
OPTIONAL: Set a delay of ~100ms to not disturb other items in the queue
Click Start Run
Important Notes
This is run from your local so please make sure to leave your computer on when processing.
Try with a small batch to start out with to ensure it works as intended.