API-Blackerz

Blackerz API for Discord, written in Python.

Endpoints

( GET ) -> https://blackerz.herokuapp.com/api/v1/bots/all

( GET ) -> https://blackerz.herokuapp.com/api/v1/bots/{BOT_ID}

( POST ) -> https://blackerz.herokuapp.com/api/v1/bots/submit/{BOT_ID}

( POST ) -> https://blackerz.herokuapp.com/api/v1/bots/{BOT_ID}/edit

( GET ) -> https://blackerz.herokuapp.com/api/v1/discord/me

( GET ) -> https://blackerz.herokuapp.com/api/v1/discord/check

( GET ) -> https://blackerz.herokuapp.com/api/v1/servers/all

( GET ) -> https://blackerz.herokuapp.com/api/v1/servers/{SERVER_ID}

( POST ) -> https://blackerz.herokuapp.com/api/v1/servers/submit/{SERVER_ID}

/api/v1/bots/all Return semua bot dalam database

/api/v1/bots/{BOT_ID}

Return informasi spesifik bot dalam database

/api/v1/bots/submit/{BOT_ID}

Post bot dengan informasi bot

/api/v1/bots/{BOT_ID}/edit

Edit data bot spesifik bot (POST | PUT)

/api/v1/bots/{BOT_ID}/edit/servercount

Edit data server count bot

/api/v1/servers/all

Return semua servers dalam database

/api/v1/servers/{SERVER_ID}

Return informasi spesifik server dalam database

/api/v1/servers/submit/{SERVER_ID}

Post data spesifik server ke database

Struktur Headers & Body untuk Upload bot;

Headers:{
     'Content-Type': 'application/json',
     'apiKey': String  // Contact developer untuk mendapatkan API key
}

BODY: {
    name: String,                                        // Nama bot
    owner: { 'id': Number | String, 'name': String },    // Id dan nama akun Discord untuk developer bot
    tag: String,                                         // Tag nama dan diskriminator 
    id: Number | String,                                 // Bot id / client id
    avatar?: String,                                     // Avatar bot icon id pada cdn.discordapp.com
    inviteLink?: String                                  // Kode untuk link untuk add bot, harus sesuai dari Discord Developer Portal
}

Struktur Headers & Body untuk Upload server;

Headers:{
     'Content-Type': 'application/json',
     'apiKey': String  // Contact developer untuk mendapatkan API key
}

BODY: {
    name: String,                                        // Nama bot
    owner: { 'id': Number | String, 'name': String },    // Id dan nama akun Discord untuk developer bot
    memberCount: Number,                                 // Jumlah member terbaru
    id: Number | String,                                 // Server id / Guild id
    joinLink: String,                                    // Kode untuk link masuk server, tidak memerlukan "https://discord.gg/"
    avatar?: String                                      // Avatar server icon id pada cdn.discordapp.com
}

Kode error

500 Terdapat error dalam server, sering terjadi saat server sedang maintenance,
429 Jumlah request melebihi batas, API membatasi jumlah reuquest dari client agar tidak terjadi penyalahgunaan,
404 Resource tidak ditemukan dalam api, termasuk bot & server yang tidak terdapat dalam database,
403 Operasi dilarang dengan alasan tertentu, dapat diketahui dengan membaca JSON response dari server,
401 Tidak terverifikasi, server menolak permintaan dari client karena kredensial yang invalid,
400 Body JSON dari client yang invalid, harus memiliki spesifikasi dari struktur data diatas.

Info lainnya

"{BOT_ID}" Adalah bot / client id yang dapat didapatkan dengan mengklik kanan icon server,
"{SERVER_ID}" Adalah server / guid id yang dapat didapatkan dengan mengklik kanan icon server,
"?" Menandakan bahwa parameter tersebut bersifat opsional, server akan mengganti dengan alternatif atau menghilangkannya.

© Copyright 2021 Fastering18/Blackerz-API