Thursday, December 20, 2012

CommPeak Services API

Due to numerous requests we have received for it, we decided to develop a services API on our portal and now we are proud to announce the release of CommPeak Services API (version 1).
Currently our API offers the basic functions which fit the basic needs of our customers.



API docs are available on http://docs.commpeak.com/api/ but before you go there, allow me to briefly explain how the CommPeak API works:

First, you will need an API key for your account to make API requests. You can get it by visiting "Setup >> API Keys" page on your CommPeak account control panel. After your key is created, the "Access token" will be generated automatically.

Once you're done with the API key, you are ready to start using our services with API requests.
Let's see an example of getting your balance information via API request. In order to get your current balance you will need to change "API_TOKEN" with your API key access token:

curl \
  -H 'Accept: application/vnd.commpeak.com; version=1,application/json' \
  -H 'Authorization: Token token="API_TOKEN"' \
  https://api.commpeak.com/customer

Looks pretty simple. The requirements are two headers:
  • 'Accept: application/vnd.commpeak.com; version=1,application/json' - defines the content type and version
  • 'Authorization: Token token="API_TOKEN"' - defines authentication parameter (API key access token)
And the URL ("https://api.commpeak.com/customer") also consists of two parts:
  • "https://api.commpeak.com/" - the basic URL
  • "customer" - API action for getting customer related information.
In order to get your current rates you must call "rates/current" action, like so:

curl \
  -H 'Accept: application/vnd.commpeak.com; version=1,application/json' \
  -H 'Authorization: Token token="API_TOKEN"' \
  https://api.commpeak.com/rates/current

For a list of available API actions and usage examples you can visit our CommPeak API doc, which also includes a PHP client available for download.

Have you heard of CommPeak's new short duration/dialer termination service? If you are a call or contact center owner in search of reliable and affordable predictive dialer traffic, visit our short duration termination page. We can set you up with a great plan!

No comments:

Post a Comment