How to connect to Mocean Data from IntelliJ

The CData JDBC Driver for Mocean enables you to access Mocean as a JDBC data source, providing integration with rapid development tools in IDEs. This article shows how to use the data source configuration wizard to connect to Mocean data in IntelliJ.

Create a JBDC Data Source for Mocean

Follow the steps below to add the driver JAR and define connection properties required to connect to Mocean data.

1. In the Data Sources window, right-click and then click Add Data Source -> DB Data Source.

2. In the Data Source Properties dialog that appears, the following properties are required:

   • JDBC Driver Files: Click the button next to this menu to add the JDBC Driver file cdata.jdbc.api.jar, located in the installation directory.
   • JDBC Driver Class: In this menu, select cdata.jdbc.api.APIDriver from the list.

   • Database URL: Enter the connection URL in the JDBC URL property. The URL must start with jdbc:api: and includes connection properties separated with semicolons.

     Using API Key Authentication

     Mocean uses API key authentication to control access to the API. To obtain an API Key:

     1. Log in to your Mocean account at https://dashboard.moceanapi.com
     2. Navigate to your account settings or API credentials section
     3. Copy your API Key

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

     • AuthScheme: Set this to APIKey.
     Set the following in the ProfileSettings connection property:
     • APIKey: Set this to your Mocean API Key. This is transmitted as a Bearer token in the Authorization header.

     Example Connection String

     Profile=C:\profiles\Mocean.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';
     

     Connecting to Mocean

     Once the authentication is configured, you can connect to Mocean and query data from any of the available tables such as AccountBalance, AccountPricing, MessageStatus, and NumberLookup.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the Mocean 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.

     

     A typical JDBC URL is the following:

     jdbc:api:Profile=C:\profiles\Mocean.apip;AuthScheme=APIKey;ProfileSettings='APIKey=your_api_key';

Edit and Save Mocean Data

To discover schema information, right-click the data source you just created and click Refresh Tables. To query a table, right-click it and then click Open Tables Editor.