Some alt text

API (beta)

Connect To The Inner Workings Of Your Community Platform Using The CMNTY API

What Is An API?

An Application Programming Interface (API) is a bridge that allows two systems to interact with each other and exchange data. CMNTY Platform already featured an API for custom projects, but we recently started working on a API that is suitable for public use. This means that anyone on our Premium plan can now start building custom apps with the CMNTY API. The first API version has now been released and you can follow progress on this page in the coming months.

Exchange Of Data

Using the API you can connect your community platform with other systems. You can use the API by sending it data over HTTPS. If you don’t know how to do this then please consult your IT team.

Before you can use the API you have to authenticate yourself to it. Once authentication is successful you can start sending and receiving data. Please be advised that API access is currently only available in our Premium plan.

Piece of Api Documentation

How to Configure and Get Started

The API requires (almost) zero configuration of your Platform. However, you have to make sure that you set some defaults in the request.
Here are the most important ones:

Piece of Api Documentation

Basic Auth

First of all you need to be authenticated. It is not possible to connect to the API without proper authentication. For authentication the platform uses Basic Auth. You can create a new application under Configure -> API. Once you have done that you will receive a token from the Platform, which you can use to authenticate yourself.


API Version

We also highly recommend you set the version of the API for any request you do. We will perform regular updates to the API and to avoid that your application stops working we will “version” the API.


Content-type

It’s also important you set the content type. For now we can only return the JSON format. Your request headers will look like the image you see here. Be sure to also have a look at our support article on how to setup the API.

"User" and "Invite" End-points

For now our API supports two “End-points” or methods. An end-point gives you access to a certain type of platform data or it can trigger certain actions.

Users

The User-endpoint currently supports the following actions: Get Users, Get User (single), Delete User, Get User Groups, Get User Points, Reward Points, Get User Points History, Get User Badges and Get User Badge History.

For example, you can get the first user of the platform by calling:

GET
https://bagelsandfriends.cmnty.com/api/user/users/1

The output will look similar to what's shown in the image.


Invites

You will also have control over the invite system of the platform. The following end-points are available: Get Invites, Create New Invite, Get Invite (Single), Update an Invite, Delete an Invite, Send an Invite, Get Invite Groups.

{
    "id": 123,
    "username": "jack",
    "email_address": "hello@example.org",
    "language": "en",
    "role": {
        "id": 123,
        "name": "Community Manager",
        "key": "community-manager"
    },
    "status": "active",
    "profile_url": "https://../user/profile/{id}/{username}",
    "avatar_url": "https://../avatar.png",
    "self": "https://../api/user/users/{id}",
    "created_at": "2017-02-28T09:39:33+00:00",
    "updated_at": "2017-02-28T09:39:33+00:00",
    "logged_in_at": "2017-02-28T09:39:33+00:00",
    "last_activity_at": "2017-02-28T09:39:33+00:00"
}

Roadmap

We are gradually building out the capabilities of our API. In the following months we will continue to add features and end-points based on customer feedback and our internal roadmap.

API Documentation

Below you find a copy of our API documentation. You can always find the latest version of the docs in the platform itself by navigating to admin > configure > api.

Try CMNTY 14 Days for FREE

Enter your email address to create your community now.