Manage Deel Data in DBArtisan as a JDBC Source

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

Integrate Deel Data into DBArtisan Projects

Follow the steps below to register Deel 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.

   To authenticate to Deel, you can use API Key (Bearer Token) authentication.

   Using APIKey Authentication

   You can authenticate using a Deel API Key. Create an API key in your Deel account settings under Settings > API or Developer Settings. Make sure to grant appropriate permissions based on the data you need to access (e.g., read access for invoices, timesheets, contracts, workers, etc.).

   After creating your API Key, set the following connection properties:

   • AuthScheme: Set this to APIKey.
   • APIKey: Set this to your Deel API Key (Bearer token).

   Example APIKey connection string

   Profile=C:\profiles\Deel.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_deel_api_key';
   

   Built-in Connection String Designer

   For assistance in constructing the JDBC URL, use the connection string designer built into the Deel 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\Deel.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_deel_api_key';

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

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