Skip to content
This repository has been archived by the owner on Jun 15, 2024. It is now read-only.
/ api Public archive

Public Open Source Version of Azrael Interactive's Global Ban API

License

Notifications You must be signed in to change notification settings

Digital-Dimensions-LLC/api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation


Azrael
Azrael

A powerful global ban API system made with Node.js

Discord

Key FeaturesHow To UseCreditsSupport

Key Features

  • Simple Setup
    • Setup your version of our API in under 5 minutes!
  • Fully Customizable
    • Need more ban reasons? Want to use specific proof links? You can customize all of that with the API's simple setup!
  • 24/7 Support
    • Let us, help you. Whether you need support with the setup, customization or maintenance of your API. We are here to help, reach out to our Banlist Client Support team for assistance.

How To Use

To clone and run this application, you'll need a linux enviroment running Node.js v14. From your command line:

# Clone this repository
$ git clone https://github.com/Azrael-Interactive/api.git

# Go into the repository
$ cd api

# Install Dependencies
$ npm install

# Run Setup
$ npm run setup

# Run the app
$ npm start

The default port is 3000, if you need to change the port, you can change it in the config.json file.

Generating API Token(s)

To generate API Token(s) for your API, an endpoint has already been created and you simply need to send a POST request to the endpoint. An example has been provided below using node-fetch v2.6.5

const body = { id: '1', action: 'CREATE' }; 
// body.id - Internal Reference ID, Used to identify the moderator on ban data. Typeof STRING
// body.action - Action to take, CREATE or DELETE a token. Typeof STRING

fetch('https://yourapi.com/admin/token', {
        method: 'POST',
        body:    JSON.stringify(body),
        headers: { 
          'Authorization': 'YOUR_MASTER_TOKEN' // Set/Update in config.json
          'Content-Type': 'application/json' 
        },
    })
    .then(res => res.json())
    .then(json => console.log(json));
    
    // Expected Response
    { "status": "200", "message": "Token Created", "data": { "internal_id": "1", "token": "2xqhbwLaSB0ZxSO47oxTKnxuOQV8rt" }}

Dependencies

Support

Join Us


azrael.gg  ·  GitHub @Azrael-Interactive  ·  Twitter @AzraelAPI  ·  Instagram @AzraelAPI

About

Public Open Source Version of Azrael Interactive's Global Ban API

Resources

License

Stars

Watchers

Forks