My API is a custom HTTP endpoint used by client applications to execute scripts in integrator.io.
1. Calls to My API endpoints trigger a script inside the integrator io platform.
2. The script then implements logic to invoke flows, exports, and imports.
3. The script handles the request and returns a response back to the client application.
My APIs are visible when Developer mode is turned on.
My APIs are only available for Account owners and Administrators.
WHEN TO USE MY API
My API is a powerful tool that can enhance the functionality of integrator.io, but it may be difficult to recognize when it’s appropriate to use it. Webhooks and integrator.io REST APIs are suitable for most situations. If these processes fall short of the needs, My APIs may be able to bridge the gap.
My API allows users to build their own API on top of integrator.io. A client application can make a request to a URL created through My API. My API will then execute scripts to return a formatted and authenticated response acceptable to the system.
Because My API makes calls outside of jobs within integrator.io, the logs, errors, and dashboard information will not be updated when data is integrated. There will be no opportunity to retry records that failed to sync within integrator.io like with normal flows.
REST API vs MY API
REST API
- Used to retrieve data, for example, inventory levels from a system like NetSuite for web stores.
- Data is always returned in JSON format.
- Authentication occurs through an API token created within integrator.io.
My API
- Utilizes JavaScript to handle authentication or data format issues that can sometimes arise when using REST APIs.
- Data can be returned in the response to the original request in the proper format
WEBHOOK Vs MY API
Webhooks
- Allow users to expose a URL that data can be pushed to in real-time when a given event occurs in an application.
- Run asynchronously. Responses advise of successful data transfers or authentication or data parsing errors.
- Cannot return data in response to the original system. For example, an internal Id of the record created in a corresponding import.
My API
- Allows subsequent calls to be made through scripting that can return more information within the response.