Skip to main content

Communic8 REST API

The Communic8 Public API is a set of RESTful JSON APIs which allow software developers to programmatically access a Communic8 client instance.

Using​

Communic8 is a multi-tenancy platform. Each Communic8 client has its own set of users and enabled features. The Public API is a feature which is typically disabled by default on a client instance, and is enabled via a support request to support@communic8.com. Once enabled, users of a sufficient permission level will be able to generate API tokens, necessary to interact with the Public API.

Permission Level​

Only one of the following categories of platform user can access the Communic8 Public API:

  • User Level of "Console User" with assigned permission "API Token - User"
  • User Level of "Super User"

To grant a Console User the permission "API Token - User", the user must be added to a User Group linked to a Permission Role containing that permission. User Groups and Permission Roles are administered by a client's Super Users. Communic8 support cannot directly administer client users, but can direct you to a client Super User who can.

Generating Tokens​

A permissioned user will be able to generate Public API tokens by clicking on their name top-right of the admin console interface and "Profile" > "My API Tokens" > "Manage". There will be a button labelled "NEW" on the interface, which can be clicked to generate new tokens.

Only at the point a token is generated will its value be visible, so make sure to copy or save the value before closing the dialog.