Most of the time, you need to find data from a company. Sometimes it's an entity you have some data for, and sometimes you need to discover something completely new.
The best option to find any data from a company is always GET companies endpoint. From here, you can look at data based on business id, company name, or various other filters. This endpoint is efficient and usually needed in more complex solutions to get data that is not available from different endpoints and functions.
Customer data allows you to save some of your data to Vainu's side. We also try to match the data you send to a company entity. Customer data is a crucial first step for either integration with webhooks or integrating our platform into your system.
Sometimes our API filters aren't enough. In this case, it's possible to utilize our platform to build complex searches with UI. This data can be accessed from the API with company lists by using list ids as a filter parameter.
Our integration endpoints and webhooks will see continuous development to make your solutions more straightforward to build when some of the logic is handled on our side.
There are multiple use cases for saving your data to Vainu. Data you save can be simple, or it may contain additional values like sales information and notes. One of the notable data fields you can save is a unique id. Unique id can be your internal id and enables easy data management when you can use native ids of the system you are integrating with. This management happens with our customer data API.
Customer data API allows your users to use data you have saved in Vainu's UI as filter parameters. For example, they could filter out companies that are already in your system. You can as well enable export functions from the Vainu platform and receive updates as webhooks.
Customer data entities are created and modified through API endpoints under Customer data. You can add, see, delete and update the data you see.
After these entities have been created, they are automatically available at the Vainu UI. You can configure webhooks through the Webhook configuration endpoint.
Webhook payloads have a limited amount of data. Usually, this might not be enough for your data needs, and the rest of the data can be easily fetched from the Get Companies endpoint with business id Vainu includes at the payload.
The GET Companies endpoint is fast and efficient for getting data. Sometimes the queries get complex, and response times get longer when needed database operations are slower.
Using some filter types like "contains" can be taxing for the API, and usually, these can be circumvented with less taxing functions, like "startswith". Another thing affecting performance is the amount of data returned. A single company with all the data fields can be rather extensive. The best performance is usually achieved when the "fields" parameter targets only the necessary data fields you need.
If operations don't have to be real-time, you can use Asynchronous endpoints for more prolonged operations. The Asynchronous endpoint allows you to send tasks to Vainu and to return later in your process to download the data.
Updated about 1 year ago