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

Adding New Connections

You can add connections from the Connections settings menu. You will need to 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 configuring your connection, you can test the connection to make sure the connection is working as intended.

Installing Additional Sources

By default, API Server ships with connections to SQL Server, MySQL, and PostgreSQL in the Windows edition, and MySQL, PostgreSQL, SQLite and Derby in the Java edition. In order to connect to Oracle, DB2, and in the Java edition, SQL Server, the appropriate connectors will need to be installed. CData connectors, however, are easy to install:

Windows

To add a new data source to the Windows edition of the API Server, you can install the corresponding CData ADO.NET provider. After restarting the API Server, an option for the new data source will be listed when creating a new connection.

Java

The Java version of the API Server connects to data sources using JDBC drivers. To add an additional data source, you can add the JDBC driver jar file in the lib directory of the Java servlet container. Please refer to the documentation of the Java web-container for specific instructions.