Manage ConvertAPI Data in DBArtisan as a JDBC Source

The CData JDBC Driver for ConvertAPI seamlessly integrates ConvertAPI data into database management tools like DBArtisan by enabling you to access ConvertAPI data as a database. This article shows how to create a JDBC source for ConvertAPI in DBArtisan. You can then edit data visually and execute standard SQL.

Integrate ConvertAPI Data into DBArtisan Projects

Follow the steps below to register ConvertAPI data as a database instance in your project:

1. In DBArtisan, click Data Source -> Register Datasource.
2. Select Generic JDBC.
3. Click Manage.
4. In the resulting dialog, click New. Enter a name for the driver and click Add. In the resulting dialog, navigate to the driver JAR. The driver JAR is located in the lib subfolder of the installation directory.
5. In the Connection URL box, enter credentials and other required connection properties in the JDBC URL.

   ConvertAPI uses API Secret Key authentication. Your ConvertAPI Secret is used to authenticate requests. You can find your API Secret in the ConvertAPI dashboard under your account settings.

   Using APIKey Authentication

   After setting the following connection properties, you are ready to connect:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your ConvertAPI API secret key.

   Example connection string:

   Profile=C:\profiles\ConvertAPI.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";
   

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the ConvertAPI JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

   java -jar cdata.jdbc.api.jar
   

   Fill in the connection properties and copy the connection string to the clipboard.

   

   Below is a typical connection string:

   jdbc:api:Profile=C:\profiles\ConvertAPI.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";

6. Finish the wizard to connect to ConvertAPI data. ConvertAPI entities are displayed in the Datasource Explorer.

You can now work with ConvertAPI data as you work with any other database. See the driver help documentation for more information on the queries supported by the ConvertAPI API.