How to Query Deel Data in MySQL Workbench

You can use the SQL Gateway from the ODBC Driver for Deel to query Deel data through a MySQL interface. Follow the procedure below to start the MySQL remoting service of the SQL Gateway and work with live Deel data in MySQL Workbench.

Connect to Deel Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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';

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to Deel data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

Query Deel from MySQL Workbench

The steps below outline connecting to the virtual Deel database created in the SQL Gateway from MySQL Workbench and issuing basic queries to work with live Deel data.

Connect to Deel through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for Deel).
3. Set the Hostname, Port, and Username parameters to connect to the SQL Gateway.
4. Click Store in Vault to set and store the password.
5. Click Test Connection to ensure the connection is configured properly and click OK.

NOTE: When we refer to Username and Password, we mean the credentials for the user(s) created for the SQL Gateway.

Query Deel Data

1. Open the connection you just created (CData SQL Gateway for Deel).
2. Click File -> New Query Tab.
3. Write a SQL query to retrieve Deel data, like SELECT * FROM `CData API Sys`.Invoices;

With access to live Deel data from MySQL Workbench, you can easily work with Deel, just like you would a MySQL database. Get started now with a free, 30-day trial of the CData API Driver for ODBC and the CData SQL Gateway.