API

From Bicom Systems Wiki

Abstract

This document can be used as a reference guide when using PBXware API. Its purpose is to help developers write 3rd party software to interact with PBXware.

Protocol

PBXware API works by sending and receiving either POST or GET requests via HTTP protocol.

Authentication

For authentication purposes, a unique API key is used.

  1. PBXware 4 - API key, by default, is not set. You can set one in Site Settings -> API key. Documentation can be found in the same place.
PBXware 4
  1. PBXware 5 - API key, by default, is predefined. You can find it in Admin Settings -> API Key. Documentation can be found in the same place.
PBXware 5

The API Key can also be generated as a random key in the interface itself.


NOTE: You must make sure API key is kept secret as it exposes rather critical functionalities to 3rd parties (e.g. Delete functionality).

Requests

Both the API key and all other necessary arguments are sent as part of HTTP GET or HTTP POST request.