You can manage a connection, import, export, or lookup by toggling between the upcoming HTTP view, an existing Simple (application-specific) view, or a REST API view. You can also learn more about the upcoming HTTP view and the existing REST API view compared to the Simple (application-specific) view.
Contents
Simple view
Application-specific (simple) forms are based on the universal HTTP connector, including only the most common settings required for integrating with the application. For example, if you’re creating an import or export to Narvar, you can pick any of their supported resources and API endpoints. Simple views allow you to configure your connections quickly and are most useful when you want a quick connection. If you want to customize and configure your connections when creating a flow, select the HTTP view.
Note: This toggle will become available for more connectors over time. It’s not currently available for every connector. An application-specific form is still available by using the application connector.
Connections
You can easily create a connection using a simple or HTTP view. Improvements to simple connection views include:
- For connections with different API versions:
- integrator.io will default to the latest API version.
- You can choose a version in your connection or export/import.
- If you can’t find a specific field in your application (like a token or API key), the Can't find? button opens a new window to the application’s Help Center article.
Exports, lookups, and imports
You can toggle between the simple and HTTP view of a connector or export, lookup, or import. The simple views now include
- Mock output (export) – simulates exported data during flow configuration or when you execute a flow test run. Instead of actually executing the export to retrieve sample data (or waiting for webhook listeners to receive data), integrator.io uses the mock output you provide to simulate export data while you are configuring your flow. Mock output is always required when running the flow in test mode. Click Populate with preview data to replace any mock output values in this editor with preview data, or enter your own sample data (max 10 records up to 1 MB in size). Mock output must be in integrator.io canonical format.
- Query parameters (export and import) – You can search through all query parameters.
- Mandatory parameters are provided for you and disabled, so they can’t be removed
- Search for, add, or delete features for query parameters
- Handlebars to add query parameters or values
- Select the setting’s value from a dropdown list, when the available choices are documented and limited
- Error messages remind you if a value isn’t set for a mandatory parameter
- Mock response (import) – Mock response data simulates a response returned by the destination application. You can use mock response data to configure the rest of your flow. You can also use mock data when running the flow in test mode to avoid interactions with the destination application while running end-to-end flow tests. Mock response data must be in integrator.io canonical JSON format.
- For resources and endpoints with different API versions
- integrator.io will default to the latest version.
- You can choose a resource, endpoint, and version, but you can only choose the version if it isn’t in the connection.
Common fields
Field |
Description |
|
Resources |
A resource is an API that an application provides. One application can have many APIs (resources). For example, Freshdesk supports APIs like Accounts, Agents, and Companies. Each API resource has at least one endpoint that you can call to get or modify information. |
|
Endpoints |
An endpoint is an operation you can call related to a specific resource. You might want to view all Freshdesk accounts, in which case you would make an export request to the View accounts endpoint. |
|
Composite endpoints (imports only) |
A combination of two endpoints performing actions. For example, when importing data to ReCharge, navigate to the available resource (ex., Addresses) and click Composite: Create new records & update existing records. integrator.io then automatically selects the create and update API endpoint for that resource. In cases where there are multiple create and update endpoints for that resource, you have the flexibility to select the create and update API on your own. |
HTTP view
If you use an HTTP export or import view, you’ll have more options and control over your connections, exports, imports, and lookups, including the HTTP method and nonstandard API response patterns like success and error values. If you’re technically proficient, you can use your experience to modify or customize your connection at the HTTP level.
REST API view
You can switch between a simple and REST API view for many of the existing connectors. However, the REST API view is being replaced by the more efficient and popular HTTP connector. Learn more about managing your REST integrations.
The General section of export and import configuration pages has a Form view setting that allows you to switch between an application-specific (if available) and a universal form.
You can use the application-specific form view or the REST API universal connector form view. Since Acumatica's platform uses REST API protocols, only the REST API universal connector form view is available.
Reasons to switch from simple to universal connector view
Since universal connectors are not specific to any app or system, they display more fields and settings than are required by any single platform because they must accommodate all systems that use those protocols. Whenever possible, you should rely on a simple connector view so that you don't have to navigate or ignore fields irrelevant to your integration.
However, a universal connector view is helpful for overriding preset settings that integrator.io chooses for you, as well as for controlling API options that aren’t readily configured in a simple connector view. Select HTTP to customize integrator.io features and create API connections, exports and lookups, or imports specific to your needs. For example, you may want to add an HTTP header that is non-mandatory and the connector you choose doesn’t send it by default. In this case, you can toggle to the HTTP view and add that header based on your integration needs.
Comments
0 comments
Please sign in to leave a comment.