Overview
importOK uses a minimalistic yet powerful schema. Putting emphasis on developer experience, our commitment is to provide a schema that is easy to grasp, but also powerful enough to meet your requirements.
Depending on your use case, you will need to define some key details to perform an import. First you need to define the fields, so that your end users can map their data. Then you will need to define some transformers to normalize and clear the data to be imported. Next, you will need to define some validation rules so that you users can get instant feedback when something is wrong. Last, but not least, you will need register your webhooks so that you can actually import the data into your backend system.
Field
A property of the entity to be imported. For example, if you importing Contacts some fields are the "First name", "Last name", "Phone" and "Email".
Transformers
Helpers that are executed right before the validation, aiming to auto correct the data to be imported. For example, to trim spaces.
Validators
Helper functions to provide instant feedback when something is wrong and it can not be auto-corrected. For example, an invalid email address.
Webhooks
Callbacks that are executed in the final step to submit the data to your API.
As a first step you will need to identify the entities that you would like to import. For example, if you are working on an e-shop you should be looking to import Products, Customers and Orders. If you are working on a CRM, these will be Contacts and Leads.