API overview


Integrate Your Solution with Buzzportal!

Features of the Buzzportal API include:

  • Supports transfer over HTTPS
  • HTTP-based
  • Ability to have multiple keys and to revoke keys
  • Limit key access to an IP address or domain
  • Manage your contacts without logging in


API Overview

The Buzzportal API is based on HTTP and implements many of the recommendations set out in the REST (Representational State Transfer) system architecture. Developers are not restricted to using PHP or the wrapper itself with the API. You can use the base API functions to write your own wrappers with any programming language you want. The PHP wrapper should serve as a good example of a wrapper that a developer could write though.



The API is a client-server API. You connect directly to Buzzportal servers.


Uniform Interface

The interface of the API is represented as resource URIs. Discovery of resources is provided by links returned in representations.



Each request is atomic. Authentication is provided on a per-call basis (there are no sessions).

The Buzzportal API supports transfers over HTTPS to help ensure that your data is secure. Authentication is done using a combination of a public identifier key and a secret key. You may have multiple key sets, which you can revoke at any time. You may also apply restrictions on the on the key, such as originating IP and domain.



Download attachments: