To integrate and connect data to the BIMachine platform, there are several options that offer flexibility and security, meeting different needs and usage scenarios. Among the main connection methods are:
- Database (via JDBC)
- FTP
- BIM Gateway
- More than 50 API connector options
- JSON connector
- JSON/CSV file upload
Below is a breakdown of each of the ways you can connect your data to the platform:
Direct Database/FTP with IP Release
Direct connection via database or FTP (File Transfer Protocol) with IP release is a secure option for transferring large volumes of data. IP release ensures that only authorized IP addresses can access the data, protecting the communication from unauthorized access.
Steps:
- Server configuration: Make sure that the database or FTP server is configured to accept connections from the specific IP, or else, on your network, make sure to release the BIMachine’s IP so that it can access the server.
- Authentication: Provide the necessary credentials (user and password) for the connection to be established.
Find out more about creating data connections by clicking here.
Conectores API
API connectors allow different programs to communicate with each other using the internet. They work like a translator, helping to exchange information easily and quickly, whether in real time or at scheduled times. In short, an API is a tool that developers use so that different programs can connect, share data and work together harmoniously, like a well-coordinated team. To find out more about these connectors, click here.
Steps:
- Endpoint configuration: Define the API endpoints that BIMachine will use.
- Authentication: Configure the API keys or tokens required for authentication.
- Connector Configuration: In the BIMachine, configure the connector to make calls to the specified endpoints and map the data as required.
Note: Each connector works according to the parameters and requirements of its respective system, and therefore has different ways of authenticating and reading data. BIMachine reads the information according to the scope enabled by each system.
BIM Gateway
BIM Gateway is an intermediate solution that facilitates data integration between BIMachine and other data sources. It acts as an aggregation point, allowing various data sources to be connected in a simplified and secure manner. Find out more about BIMGateway.
Steps:
- Gateway installation: Install the BIM Gateway in the desired environment (local or cloud).
- Integration with BIMachine: Configure BIMachine to connect to the BIM Gateway and access the aggregated data.
Conector JSON
The JSON Connector allows custom data to be integrated via APIs that return data in JSON format. This approach is ideal for scenarios where the data does not fit into a standard API format and needs to be customized. If your system doesn’t have a specific API, you can use the generic BIMachine API to connect the data or develop an API in your system and use this connector. See more here.
Steps:
- Creating the JSON structure: Create the JSON structure.
- API configuration: Define the JSON endpoints that will be consumed, and enter the authentication data, if any.
API Sending JSON/CSV File
*Available from version 2.80.0 onwards
To integrate data using JSON or CSV files, the API allows these files to be sent directly to the BIMachine platform. This is a practical approach to transferring bulk data in a structured way.
Steps:
- JSON/CSV file creation: Format the data in JSON or CSV files as required.
- Sending Files: Use API calls to send JSON/CSV files to the BIMachine.
BIMachine offers multiple ways of connecting data, providing flexibility and security to meet the different needs of users. Whether through direct connections to databases and FTP, use of API connectors, BIM Gateway, or sending JSON/CSV files, the platform facilitates efficient data integration and management.
