Getting Started

To get started with RoleplayBot's API you must meet the prerequisites. This guide is based on accessing the API from a REST client, The API can also be accessed through other means.

The API has been deprecated and is no longer in use.

Prerequisites

• Access to a REST Client (Recommended For PC, Insomnia)

• Basic knowledge of computing

• Access to a computer (HIGHLY RECOMMENDED)

• Authorization Key

• Your Guild ID

Requirements

Firstly, We will start by accessing an Authorization key for your server (Need a key? View here) and getting your guild ID. Authorization keys secure the API and restrict only authorized users from accessing sensitive guild data, Your guild ID is required to access and send data specific to your guild. Need help getting your guild ID? View here.

Getting started

Now, Lets make a request to the API using the fields we just gathered.

API Version

GET https://roleplaybot.xyz/api/version

Returns the current API version

Headers

Name	Type	Description
Authorization*	API_KEY	API Authorization Key
Guild*	GUILD_ID	Discord Guild ID

401: Unauthorized Invalid Authorization Key (Field empty or invalid key)

{
	"authentication": false,
	"error": "401 Unauthorised",
	"details": "Invalid Authorization key (20050)"
}

200: OK Successful Request

{
    "version": "v1.1.xx"
}

Advancing

To advance further check out our other Guides!