Ready to get started?

Learn more about CData Cloud Hub or sign up for a free trial:

Learn More

Access BigCommerce Data in PHP through the Cloud Hub

Connect to BigCommerce through the standard MySQL libraries in PHP.

You can use the CData Cloud Hub to access BigCommerce data from MySQL clients, without needing to perform an ETL or cache data. Follow the steps below to create a virtual MySQL database for BigCommerce and connect to BigCommerce data in real time through PHP's standard MySQL interfaces, mysqli and PDO_MySQL.

The CData Cloud Hub provides a pure MySQL, cloud-to-cloud interface for BigCommerce, allowing you to easily query live BigCommerce data in PHP — without replicating the data to a natively supported database. As you query data in PHP, the CData Cloud Hub pushes all supported SQL operations (filters, JOINs, etc) directly to BigCommerce, leveraging server-side processing to quickly return BigCommerce data.

Create a Virtual MySQL Database for BigCommerce Data

CData Cloud Hub uses a straightforward, point-and-click interface to connect to data sources and generate APIs.

  1. Login to Cloud Hub and click Databases.
  2. Select "BigCommerce" from Available Data Sources.
  3. Enter the necessary authentication properties to connect to BigCommerce.

    BigCommerce authentication is based on the standard OAuth flow. To authenticate, you must initially create an app via the Big Commerce developer platform where you can obtain an OAuthClientId, OAuthClientSecret, and CallbackURL. These three parameters will be set as connection properties to your driver.

    Additionally, in order to connect to your BigCommerce Store, you will need your StoreId. To find your Store Id please follow these steps:

    1. Log in to your BigCommerce account.
    2. From the Home Page, select Advanced Settings > API Accounts.
    3. Click Create API Account.
    4. A text box named API Path will appear on your screen.
    5. Inside you can see a URL of the following structure: https://api.bigcommerce.com/stores/{Store Id}/v3.
    6. As demonstrated above, your Store Id will be between the 'stores/' and '/v3' path paramters.
    7. Once you have retrieved your Store Id you can either click Cancel or proceed in creating an API Account in case you do not have one already.
  4. Click Test Database.
  5. Click Privileges -> Add and add the new user (or an existing user) with the appropriate permissions.

With the virtual database created, you are ready to connect to BigCommerce data from any MySQL client.

Connect in PHP

The following examples show how to use object-oriented interfaces to connect and execute queries. Initialize the connection object with the following parameters to connect to the virtual MySQL database:

  • Host: Specify the remote host location where the service is running. In this case "myinstance.cdatacloud.net" is used for the remote host setting since the service is running on the local machine.
  • Username: Specify the username for a user you authorized in the Cloud Hub.
  • Password: Specify the password for the authorized user account.
  • Database Name: Specify the name of the virtual database you created for BigCommerce.
  • Port: Specify the port the service is running on, port 3306 in this example.

mysqli

<?php
$mysqli = mysqli_init();

$mysqli->ssl_set("C:/certs/cloudclient.key",
                 "C:/certs/cloudclient.pem",
                 "C:/certs/myCA.pem",
                 NULL,NULL);

$mysqli->real_connect("mysintance.cdatacloud.net", "admin", "mypassword", "bigcommercedb",3306,NULL,MYSQLI_CLIENT_SSL_DONT_VERIFY_SERVER_CERT);
?>

PDO

<?php
$pdo = new PDO('mysql:host=myinstance.cdatacloud.net;dbname=bigcommercedb;port=3306;','admin', 'mypassword', array(
    PDO::MYSQL_ATTR_SSL_KEY                => 'C:/certs/cloudclient.key',
    PDO::MYSQL_ATTR_SSL_CERT               => 'C:/certs/cloudclient.pem',
    PDO::MYSQL_ATTR_SSL_CA                 => 'C:/certs/myCA.pem',
    PDO::MYSQL_ATTR_SSL_VERIFY_SERVER_CERT => false
    )
);
?>

Query in PHP

With the connection established, you can then access tables. The following steps walk through the example:

  1. Query the table; for example, Customers. The results will be stored as an associative array in the $result object.
  2. Iterate over each row and column, printing the values to display in the PHP page.
  3. Close the connection.

mysqli

$result = $mysqli->query("SELECT FirstName, LastName FROM Customers WHERE FirstName = 'Bob'");
while($row = $result->fetch_assoc()) {
  foreach ($row as $k=>$v) {
    echo "$k : $v";
    echo "<br />"; 
  }
}
$mysqli->close();

PDO

$result = $pdo->query("SELECT FirstName, LastName FROM Customers WHERE FirstName = 'Bob'");
while($row = $result->fetch(PDO::FETCH_ASSOC)) {
  foreach ($row as $k=>$v) {
    echo "$k : $v";
    echo "<br />"; 
  }
}
$result = null;
$pdo = null;