API Access

Overview

Modr8 offers bot owners the ability to access some of the data generated by the platform and your chat through its API. We have had cases where being able to access reputation data for users has allowed whole ecosystems to be built out including using reputation points to purchase swag and merchandise from stores.

Gaining Access To Modr8 API

Bot owners are able to access the Modr8 API credentials. These can then be passed on to a developer to authenticate with Modr8 API gateway and use the relevant methods for extracting data.

1. Login to the Modr8 platform

2. Select "Manage" on your bot profile

3. Select the "Bot Menu" below your bot profile image

4. Select "API" from the drop down menu

5. A token will be displayed in the grey input box, copy this to use for accessing the API.

6. Review instructions displayed on the API Information card to see the web address required to access the platform API.

You are able to renew the token by clicking the red button labelled "Renew Token"

API Methods & Usage

The following table lists the existing API methods available and a description for their usage. We will be adding new methods as requested.

Topic	Method	End Point	Description
Chat List	GET	chats/	List of registered chats.
Chat Users	GET	chats/{{chat_id}}/users	List of tracked users in chat.
Chat User	GET	chats/{{chat_id}}/users/{{user_id}}	Specific tracked user in a chat.
All Reputation	GET	chats/{{chat_id}}/reputation	Reputation points by user.
Single User Reputation	GET	chats/{{chat_id}}/reputation/{{user_id}}	Retrieve reputation for a single user.
Add User Reputation	PUT	chats/{{chat_id}}/reputation/{{user_id}}/add/{{amount}}	Add reputation points to a user.
Remove User Reputation	PUT	chats/{{chat_id}}/reputation/{{user_id}}/remove/{{amount}}	Remove reputation points from a user.