As we've introduced before, an Item is the representation of a connection with a specific Connector of an Institution, and serves as the entry point to access the set of products recovered from the user that gave his consent to collect his/her data.
To create an Item, the easiest, most polished, battle-tested, and least error-prone way for a user, is interacting with our Pluggy Connect Widget, where he can provide his consent, follow through the Institution authentication steps, and quickly have his/her products available in our API.
Otherwise, you can develop an application that implements the Item creation flow yourself, although this can be a daunting, complex task, and difficult to get right; so it's not the preferred choice we recommend.
To access the data of the Item collected products, you'll have to interact with our API using the related endpoints. To help reduce development times, we provide several Server side SDKs (if none suits you please let's us know! We'll be happy to help.)
Once created, an Item will have a reference to the stored user parameters and credentials needed to execute the data collection with the institution. Note that all credentials are encrypted, and can never be retrieved from the API.
This enables Pluggy to run our Daily auto-sync process, which implies once every 24 hours, collecting the data of the last few days only, and automatically adding it to the already collected data.
This way, you'll always have up-to-date access to the product data of the connected Institution, and you won't require to set up any batch process to update your connections, just listen to webhook notifications.
It's possible to listen to Webhook Notifications to recover all events related to a created Item. For this, you'll only need to provide a valid URL in the
webhookUrl parameter, either when creating a Connect Token, or in the Item creation request itself.
You can find more information in the Webhook section.
Updated about 1 month ago