VOOZH about

URL: https://www.cdata.com/kb/tech/mocean-odbc-dbartisan.rst

⇱ Connect to Mocean Data in DBArtisan

Connect to Mocean Data in DBArtisan

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use wizards in DBArtisan to configure Mocean data as a data source.

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

Integrate Mocean Data into DBArtisan Projects

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

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.

You can then follow the steps below to register Mocean data as a database instance in your project:

  1. In DBArtisan, click Data Source -> Register Datasource.
  2. Select Generic ODBC.
  3. Enter a name for the data source and select the DSN. 👁 The DSN of the data source to be registered. (Salesforce is shown.)
  4. Finish the wizard to connect to Mocean data. Mocean entities are displayed in the Datasource Explorer. 👁 The Datasource Explorer. (Salesforce is shown.)

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

👁 The results of a query. (Salesforce is shown.)