Version 23.0.9145

• Adding Connections
• Installing Additional Sources
  • .NET Edition
  • Cross-Platform Edition

To expose resources and actions to the API, you must first configure a connection to your data source. API Server supports connections to any connector offered by CData, in addition to SQL Server, Oracle, and DB2.

Adding Connections

Add connections by navigating to Settings > Connections. Either enter the information necessary to connect to your data source, or specify a connection string. The required information can vary depending on the data source you’re connecting to. After you configure the connection, test the connection to make sure it is working as intended.

Installing Additional Sources

API Server ships with the following connections:

• .NET edition: SQL Server, MySQL, and PostgreSQL
• Cross-Platform edition: MySQL, PostgreSQL, SQLite and Derby

To connect to Oracle, DB2, and SQL Server (for the Cross-Platform edition only), you need to install the appropriate connectors. CData connectors, however, are easy to install. See the following instructions.

.NET Edition

To add a data source to the .NET edition of API Server, install the corresponding CData ADO.NET provider. After you restart API Server, the new data source appears in the list of available connections.

Cross-Platform Edition

The Cross-Platform edition of API Server connects to data sources using JDBC drivers. To add a data source, add the JDBC driver JAR file to the lib directory of the Java servlet container. Refer to your Java web container documentation for detailed instructions.