Integrations allow INTERA to retrieve information from external business systems such as billing platforms, accounting software, CRM systems, ERP platforms, banking services, spreadsheets, and operational databases.
This chapter explains how to connect your first Integration.
Before You Begin #
Before creating an Integration, make sure you have the connection details for the external system.
Depending on the Integration, you may need:
- the system URL or API address;
- a username and password;
- an API key or access token;
- a database name;
- an account, tenant, or company identifier;
- network access to the external system;
- permission to read the required data.
The exact fields depend on the selected Integration.
INTERA should normally use a dedicated read-only account. This reduces security risk and prevents accidental changes in the connected system.
Open the Integrations Page #
To create a new Integration:
- Open Settings.
- Select Integrations.
- Click Add Integration or Create Integration.
- Select the system you want to connect.
The available Integrations may be grouped by category, such as:
- Accounting;
- Billing;
- CRM;
- ERP;
- Banking;
- Logistics;
- Navigation;
- Manufacturing;
- Shipmanagement;
- Telecom and Network;
- External Data Services.
After selecting an Integration, INTERA displays the settings required for that system.
Enter the Connection Settings #
Connection settings tell INTERA how to reach and authenticate with the external system.
The available fields may include the following.
Integration Name #
Enter a clear name that identifies this connection.
Examples:
- Main Accounting System
- Cyprus Billing Platform
- Production CRM
- Fleet Management Database
- Revolut Business Account
The name is used throughout INTERA when selecting data sources and reviewing synchronization results.
URL or Server Address #
Enter the address of the external system.
This may be:
- a website URL;
- an API endpoint;
- a server hostname;
- an IP address;
- a database server address.
Examples:
https://api.example.combilling.company.localUse the address supplied by the system administrator or service provider.
Do not add a page address intended only for normal browser access unless the Integration specifically requests it. Some systems use a separate API address.
Login and Password #
Enter the username and password used by INTERA to access the system.
Whenever possible, create a dedicated account for INTERA with only the permissions required to read the necessary information.
Avoid using a personal administrator account.
API Key or Access Token #
Some systems use an API key or access token instead of a username and password.
Copy the value exactly as provided by the external system.
API keys and tokens are normally case-sensitive. Make sure that:
- no characters are missing;
- no extra spaces are included;
- the key has not expired;
- the key has permission to access the required data.
Additional Connection Parameters #
Some Integrations may require additional information, such as:
- tenant ID;
- company ID;
- organisation code;
- database name;
- port number;
- region;
- authentication method;
- certificate;
- workspace or account identifier.
Complete all required fields before testing the connection.
Test the Connection #
After entering the connection settings, click Test Connection.
INTERA will attempt to:
- reach the external system;
- verify the supplied credentials;
- confirm that the required API or service is available;
- check whether the account has sufficient permissions.
A successful test confirms that INTERA can connect to the system. It does not always confirm that every required dataset is available.
If the test fails, review the error message and check:
- the URL or server address;
- the login and password;
- the API key or access token;
- network or firewall restrictions;
- account permissions;
- whether the external service is currently available.
Some systems allow connections only from approved IP addresses. In this case, the INTERA server may need to be added to the external system’s access list.
Define Synchronization Options #
Synchronization options determine how and when INTERA retrieves data from the connected system.
The available options depend on the Integration.
Synchronization Frequency #
Choose how often INTERA should request updated information.
Common options include:
- every few minutes;
- hourly;
- daily;
- on a defined schedule;
- manually;
- when requested by a dashboard or rule.
Choose a frequency appropriate for the data.
For example:
- network status may require frequent updates;
- bank balances may update hourly;
- accounting totals may update once per day;
- monthly reports may only need to update after the accounting period closes.
More frequent synchronization may increase the load on both INTERA and the external system.
Initial Synchronization Range #
Some Integrations require a time range for the first synchronization.
Examples include:
- current month;
- previous three months;
- current financial year;
- last 30 days;
- records updated after a selected date.
A larger initial range may take longer to process.
Select only the history required for dashboards, Metrics, and reconciliation rules.
Time Zone #
Select the time zone used by the external system.
This is important for:
- daily totals;
- transaction dates;
- scheduled synchronization;
- event timestamps;
- reconciliation periods.
An incorrect time zone can cause records to appear in the wrong day or reporting period.
Data Selection #
Some Integrations allow you to select which datasets should be synchronized.
Examples include:
- customers;
- invoices;
- payments;
- products;
- tickets;
- vessels;
- bank accounts;
- service records.
Select only the datasets required by your INTERA configuration.
Additional datasets can normally be enabled later.
Filters #
Filters restrict which records are retrieved.
Examples include:
- active customers only;
- selected companies or departments;
- specific bank accounts;
- selected vessels;
- records from a defined date range;
- selected products or service types.
Filters help reduce unnecessary data transfer and keep the Integration focused on relevant operational information.
Synchronization Mode #
Depending on the Integration, you may be able to choose between different synchronization modes.
Full Synchronization #
INTERA requests the complete selected dataset.
This is normally used during the initial setup or when rebuilding local information.
Incremental Synchronization #
INTERA requests only records that were created or changed since the previous synchronization.
This is normally faster and places less load on the external system.
Live Request #
INTERA requests information directly when it is needed instead of storing a synchronized copy.
This may be used for information that must always reflect the current state of the external system.
The available mode is determined by the capabilities of the Integration.
Save the Integration #
After completing the connection and synchronization settings, click Save.
The Integration will appear in the Integrations list.
Its status may be shown as:
- Connected;
- Synchronizing;
- Ready;
- Warning;
- Connection Error;
- Disabled.
If automatic synchronization is enabled, INTERA will begin retrieving data according to the selected schedule.
You may also be able to start the first synchronization manually.
un the First Synchronization #
Open the Integration and click Synchronize Now or Run Sync.
During synchronization, INTERA may display:
- the current status;
- the start time;
- the number of records processed;
- warnings;
- errors;
- the last successful synchronization time.
The first synchronization may take longer than later incremental synchronizations.
Do not change the connection settings while a synchronization is running unless the process has failed and must be restarted.
eview the Synchronization Result #
After synchronization is complete, review the result.
Check that:
- the synchronization finished successfully;
- the expected datasets were found;
- records were returned;
- dates and time periods are correct;
- no permission errors were reported;
- no required fields are missing.
A successful connection does not necessarily mean that the returned data is ready for use. Some Integrations may still require field mapping, Asset matching, or package configuration.
Common Connection Problems #
Invalid Credentials #
The username, password, API key, or token was rejected.
Verify the credentials and confirm that the account is active.
Access Denied #
The account can connect but does not have permission to access the requested dataset.
Update the account permissions in the external system.
System Not Reachable #
INTERA cannot reach the URL or server.
Check the address, firewall rules, VPN connection, and network routing.
API Not Enabled #
Some systems require API access to be enabled separately.
Confirm that the API is active and that the selected account is allowed to use it.
Expired Token #
Access tokens may expire after a defined period.
Generate a new token and update the Integration settings.
No Data Returned #
The connection is working, but the selected filters or time range returned no records.
Review the synchronization options and expand the selected range if necessary.
Rate Limit Reached #
The external system may limit the number of API requests.
Reduce the synchronization frequency or contact the system provider to increase the allowed request limit.
Security Recommendations #
When connecting an external system:
- use a dedicated INTERA account;
- use read-only permissions whenever possible;
- do not share credentials between users;
- store API keys only in the Integration settings;
- rotate passwords and tokens regularly;
- remove access when an Integration is no longer used;
- review synchronization logs for unexpected errors.
INTERA protects stored credentials and does not display passwords or full API keys after they have been saved.
