...
APIv1
...
SDK
| Warning |
|---|
| ProVision's APIv1 system has been replaced by APIv2, and is now considered deprecated. |
The 6connect ProVision API allows you to access to data and functions of the 6connect ProVision web tools. The Software Developer Kit (SDK) for PHP or Python will help you get this setup quickly by outlining the requirements, prerequisites and provide sample code.
| Table of Contents | ||
|---|---|---|
|
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@6connectour sales team.com.
Create Your API Credentials
To use the 6connect ProVision SDK for PHP, you will need a 6connect an API Key and Secret Key.
To create your API Key and Secret Key:
- Log into your 6connect ProVision instance (hosted or local)
- Click on the Admin icon, and go into the Administration section.
- Click on the "API" tab.
- Select the user from the drop down you want to enable API access for, and click "Generate Keys".
- The API Key and the Secret Key will now appear directly below that.
*Note that generating a new API will automatically revoke an older API Key.
| Info |
|---|
| 6connect recommends We recommend that each user accessing the API have their own API key configured. However, you can alternatively setup API users by functionality or roles. While the platform is flexible, you should follow your organizations security policies. |
Important!
| Note |
|---|
Your Secret Key is a secret! Only you and 6connect shouldthey key provider should ever know this information. It is important to keep it confidential to protect the privacy of your data.
|
Requirements
Aside from following the prerequisites, you will need a basic understanding of object oriented programming in PHP and the right tools installed on your system to use the API.
Minimum Requirements
...
Install the SDK
Download the file "6connect_ProVision_PHP_SDK_5_1_4.tar" from the attachments list below:
...
You must setup user API access before running the sample. See the previous section "Create Your API Credentials" for more information.
SDK for Python
| Note | ||
|---|---|---|
| ||
| This section is in progress. More information will be added as we improve and refine our new Python SDK! |
Install the SDK
Download the file "6c-api-examples-python.zip" from the attachments list below:
| Expand | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
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!
...
You must setup user API access before running the sample. See the previous section "Create Your API Credentials" for more information.
...
Additional Information
...
If you need more general information on the API, see Developer Tools.
...
If you need information on methods available via the API, see the individual APIv1 Module Documentation pages:
...
the API v1 page for the module.