6connect API - Getting Started with the SDK

...

The 6connect API allows you to access to data and functions of the 6connect web tools. The SDK for PHP or Python will help you get this setup quickly by outlining the requirements, prerequisites and provide sample code.

Table of Contents
maxLevel 3

SDK for PHP

Prerequisites

The API only comes with a licensed 6connect ProVision application. If you would like access to a ProVision license please contact sales@6connect.com.

...

• Extract the zipped tar file to a directory.
• Open the api-config.php located in the downloaded SDK files.
• Read through the file and place in your instance name (or path for local installs), API Key and Secret Key information as specified.
• Make sure all files are in the same directory (the core class looks for a config file in the same directory by default).
• Run the sample code api-examples.php!

Important!

You must setup user API access before running the sample. See the previous section "Create Your API Credentials" for more information.

SDK for Python

Install the SDK

Download the file 6connect-Python-SDK.zip

Configure the SDK Security Credentials

• Extract the zipped tar file to a directory.
• Open the apiclient.py located in the downloaded SDK files.
• Read through the file and place in your instance name (or path for local installs), API Key and Secret Key information as specified.
• Make sure all files are in the same directory (the core class looks for a config file in the same directory by default).
• Run the sample code api-examples.php!

Important!

You must setup user API access before running the sample. See the previous section "Create Your API Credentials" for more information.

Need More Information?

If you need more general information on the API, try the API Overview.
If you need information on methods available via the API, look at the API Reference.
The SDK also contains a README file with other useful information particular to php.