Getting Started with Callsavvy API

?Introduction

Callsavvy API is designed for developers to easily integrate Callsavvy on any application using any software programing technology or development platform

Our API attempts to conform to the RESTful design principles. You interact with the resources exposed through the API by accessing resource collection and element URIs using the HTTP POST or GET.

Access to our API is Freely available to all Callsavvy users. You will likely need access to a web developer or programmer (if you’re not one) to get the most use out of UfitPay API.

Obtaining Your API credentials

In order to interact with Callsavvy APIs, you will need your API credentials. You can find your API credentials when you navigate to Settings -> API & Integration from from Callsavvy workplace. You need to be logged in as an Admin to access API credentials.

For added security, we recommend you restrict access to your API credentials to only white-listed IP addresses and domains. You can do this under Whitelisted Domains

Authentication

All requests to Callsavvy API require authentication. Our API Authentication is implemented as HTTP Header Authentication over TLS (HTTPS).

To authenticate your request, you need to pass the following parameters as part of your HTTP request headers;

Public-Key: Your API Public Key
Private-Key: Your API Private Key

URL Format

Callsavvy API URL is made up of the Base URL and the Resource URI. A complete API URL will look like this; https://api.getcallsavvy.com/v1/‹resource URI›

Request Method

Our API accepts only JSON Encoded HTTP POST requests. Any other request method will not be recognized by our API

Below is a sample request to our balance enquiry API using cURL;
curl --request POST \
   --url 'https://api.getcallsavvy.com/v1/getSummary' \
   --header 'Public-Key: 1234567890' \
   --header 'Private-Key: 33gTuienGR83HY32cGt' \
   --header 'content-type: application/json'
   --data '{"parameter":"value"}'

Response Format

Our API response (success or error) is returned in JSON data. Response codes are sent via the normal HTTP Response Code,

A success response from our server will look like this;
{
   "resource": "getSummary",
   "status":"success",
   "data":{
       "assigned_number": "123456",
       "business_id": "ab9363nd8o3h"
    }
}

An error response from our server will look like this;
{
    "resource": "getSummary",
    "status":"error",
    "message":"Invalid API credentials"
}

Response Parameters

Sandbox Credentials

Feel free to use the following API credentials for development and testing purposes.