API INTRODUCTION

Bizstim CRM Business software uses a REST API architecture. Navigate to the API Index menu option above to see a full list of methods available. Over time, we will add to the methods available.

To use our API you will need to have a trial account or Enterprise account. You can review the features and prices for our All-In-1 CRM at your convenience. Click here to register for a FREE 21 day trial.

To use our API you need to generate an API Key. Once you have registered an account, login to your account and go to SETTINGS > SYSTEM (settings from the main menu and system from the sub-menu). You will see an area marked, "API Settings." Click on the "Generate API Key" button. Copy and paste the generated, 40 character API key to your web script.

HOW TO MAKE AN API REQUEST

Below is an example of a script using cURL to access the Bizstim CRM API. Replace the [METHOD] with the method you wish to use. If the method has a required parameter, replace the [PARAMETER] with this value. Typically, the parameter is an id associated with the table storing the data.

IMPORTANT: separate method names and parameters with a " / " and NOT a " ?id=### ." You can append the API call with a " ?format=xml" to style the response object in xml format. The default response object is json. Compatible formats include: json, jsonp, php, serialized, and xml.

Here is an example of an API call that returns a specific client by their client id in xml:

https://www.bizstim.com/api/client/5121?format=xml

EXAMPLE API REQUEST

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://www.bizstim.com/api/{METHOD}/{PARAMETER}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "cache-control: no-cache",
    "x-api-key: {PASTE-API-KEY-HERE}"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

In the example above we are echoing out the response. Don't do this in production! Instead, store the response in a $response variable and use the data accordingly.

USING GET METHODS

When you retrieve data on clients, practitioners, or staff it's important you make a GET Request to all users or a specific user of that user type. These responses will return other table id's you will need to request the users availability, settings, and user login information.

If you aren't sure what this means, we urge you to review the API Methods in more detail to achieve a good understanding of the required parameters and resulting responses. From there you will be able to map out the sequence of your API calls.

API CALL LIMITATIONS

You are allowed 100 requests per hour per method per API key. Make sure your scripts do not exceed the call limits. API calls that exceed the hourly limit will not be responded to with valid data.