How to Query ApprovalMax Data in MySQL Workbench

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

Connect to ApprovalMax 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.

Start by setting the Profile connection property to the location of the ApprovalMax Profile on disk (e.g. C:\profiles\ApprovalMax.apip). Next, set the ProfileSettings connection property to the connection string for ApprovalMax (see below).

ApprovalMax API Profile Settings

To authenticate to ApprovalMax and connect to your own data or to allow other users to connect to their data, the ApprovalMax Public API requires the OAuth 2.0 authorization code flow.

First, you will need to register an OAuth application with ApprovalMax. Sign in to the ApprovalMax Developer Portal (https://developer.approvalmax.com/applications) and create a new application. Your OAuth application will be assigned a Client ID and a Client Secret, and you must register at least one Redirect URI (Callback URL).

A Premium ApprovalMax subscription (or active trial) is required to use the Public API.

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

• AuthScheme: Set this to OAuth.
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to manage the process to obtain the OAuthAccessToken.
• OAuthClientId: Set this to the Client ID that is shown in your application settings on the ApprovalMax Developer Portal.
• OAuthClientSecret: Set this to the Client Secret that is shown in your application settings on the ApprovalMax Developer Portal.
• CallbackURL: Set this to the Redirect URI that is registered in your application settings.
• Scope: (Optional) Override the default OAuth scopes. The default value openid offline_access https://www.approvalmax.com/scopes/public_api/read grants read-only access to all tables in this profile and enables refresh tokens. Use the principle of least privilege when narrowing this scope.

The OAuth Authorization URL is https://identity.approvalmax.com/connect/authorize and the Token URL is https://identity.approvalmax.com/connect/token. Both authorization_code and refresh_token grant types are supported.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to ApprovalMax 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 ApprovalMax from MySQL Workbench

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

Connect to ApprovalMax through the SQL Gateway

1. In MySQL Workbench, click to add a new MySQL connection.
2. Name the connection (CData SQL Gateway for ApprovalMax).
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 ApprovalMax Data

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

With access to live ApprovalMax data from MySQL Workbench, you can easily work with ApprovalMax, 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.