Connect to ConvertAPI Data in DBArtisan
The CData ODBC 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 an data source for ConvertAPI in DBArtisan and execute queries. You can then edit data visually and execute standard SQL.
Integrate ConvertAPI Data into DBArtisan Projects
If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.
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";
You can then follow the steps below to register ConvertAPI data as a database instance in your project:
- In DBArtisan, click Data Source -> Register Datasource.
- Select Generic ODBC.
- Enter a name for the data source and select the DSN.
- 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.
