Versions Compared

Old Version 5

changes.mady.by.user The Force

Saved on

compared with

New Version Current

changes.mady.by.user The Force

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version HG-8.3.0

...

Expand

Prerequisites

The API only comes with a licensed ProVision ProVision application.

Create Your API Credentials

To use the ProVision SDK for PHP, you will need a ProVision API Key and Secret Key.

To create your API Key and Secret Key:

  • Log into your 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
Each user accessing the API should 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 should ever know this information. It is important to keep it confidential to protect the privacy of your data. Store it securely and never share this key with other users or place it on other systems. Never include the secret key in support requests, and never e-mail it to anyone. Do not share it outside your organization. No one who legitimately represents a ProVision seller will ever ask you for your Secret Key.

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

If you aren't sure what is running on your system, you can create a php page on your system and call phpinfo() and view this page in a browser, or run php -i on the command line.

Install the SDK

Download the file "ProVision_PHP_SDK_5_1_4.tar" from the SDK page. 

 

Configure the SDK Security Credentials

  • 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.

...

Expand

Install the SDK

Download the file "6c-api-examples-python.zip" from the SDK page. 

 

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.


APIv1 Documentation (Deprecated)

Children Display