Natively Connect to Mocean Data in PHP

Drop the CData ODBC Driver for Mocean into your LAMP or WAMP stack to build Mocean-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Mocean data, execute queries, and output the results.

Configure a DSN

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.

Establish a Connection

Open the connection to Mocean by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.

$conn = odbc_connect("CData ODBC API Source","user","password");

Connections opened with odbc_connect are closed when the script ends. Connections opened with the odbc_pconnect method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources, and queries execute faster.

$conn = odbc_pconnect("CData ODBC API Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the odbc_prepare function.

$query = odbc_prepare($conn, "SELECT * FROM AccountBalance WHERE  = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM AccountBalance WHERE  = ?");
$success = odbc_execute($query, array(''));
  

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC API Source","user","password");
$query = odbc_exec($conn, "SELECT ,  FROM AccountBalance WHERE  = ''");
  

Process Results

Access a row in the result set as an array with the odbc_fetch_array function.

$conn = odbc_connect("CData ODBC Mocean data Source","user","password");
$query = odbc_exec($conn, "SELECT ,  FROM AccountBalance WHERE  = ''");
while($row = odbc_fetch_array($query)){
 echo $row[""] . "\n";
}

Display the result set in an HTML table with the odbc_result_all function.

$conn = odbc_connect("CData ODBC Mocean data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM AccountBalance WHERE  = ?");
$success = odbc_execute($query, array(''));
if($success)
  odbc_result_all($query);

More Example Queries

You will find complete information on the driver's supported SQL in the help documentation. The code examples above are Mocean-specific adaptations of the PHP community documentation for all ODBC functions.