Integrate ConvertAPI Data in Pentaho Data Integration
The CData API Driver for JDBC enables access to live data from data pipelines. Pentaho Data Integration is an Extraction, Transformation, and Loading (ETL) engine that data, cleanses the data, and stores data using a uniform format that is accessible.This article shows how to connect to ConvertAPI data as a JDBC data source and build jobs and transformations based on ConvertAPI data in Pentaho Data Integration.
Configure to ConvertAPI Connectivity
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.
When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.
Below is a typical JDBC URL:
jdbc:api:Profile=C:\profiles\ConvertAPI.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";
Save your connection string for use in Pentaho Data Integration.
Connect to ConvertAPI from Pentaho DI
Open Pentaho Data Integration and select "Database Connection" to configure a connection to the CData API Driver for JDBC
- Click "General"
- Set Connection name (e.g. ConvertAPI Connection)
- Set Connection type to "Generic database"
- Set Access to "Native (JDBC)"
- Set Custom connection URL to your ConvertAPI connection string (e.g.
jdbc:api:Profile=C:\profiles\ConvertAPI.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key";
- Set Custom driver class name to "cdata.jdbc.api.APIDriver"
- Test the connection and click "OK" to save.
Create a Data Pipeline for ConvertAPI
Once the connection to ConvertAPI is configured using the CData JDBC Driver, you are ready to create a new transformation or job.
- Click "File" >> "New" >> "Transformation/job"
- Drag a "Table input" object into the workflow panel and select your ConvertAPI connection.
- Click "Get SQL select statement" and use the Database Explorer to view the available tables and views.
- Select a table and optionally preview the data for verification.
At this point, you can continue your transformation or jb by selecting a suitable destination and adding any transformations to modify, filter, or otherwise alter the data during replication.
Free Trial & More Information
Download a free, 30-day trial of the CData API Driver for JDBC and start working with your live ConvertAPI data in Pentaho Data Integration today.