Opslink Servers API

OpsLink provides a secure REST + Socket.IO API for authentication, server listings, moderation, reviews, and QR-based login.

---

The API is currently <b>NOT</b> public! We are working to make a public version, until then please note any attempts to connect are logged and audited.

🚀 Onboarding

Base URL

https://opslinkservers-backend.onrender.com/api

Requirements

• HTTPS client

• JSON support

• JWT storage (localStorage or memory)

---

🔐 Authentication

Login Flow

1

User logs in

Client sends credentials to the login endpoint.

2

Server returns JWT

On successful authentication the server responds with a JWT and user info.

3

JWT sent via Authorization header

For subsequent authenticated requests include the token:

Authorization: Bearer YOUR_JWT_TOKEN

Token Invalidation

• Password change invalidates old tokens

• Token version mismatch → 401

---

👤 Auth Endpoints

POST /auth/login

Request

{ "email": "[email protected]", "password": "password123" }

Response

{ "token": "JWT_TOKEN", "user": { "id": "abc123", "username": "kareem", "role": "user" } }

cURL

curl

curl -X POST https://opslinkservers-backend.onrender.com/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"[email protected]","password":"password123"}'

JavaScript

---

📱 QR Login (Socket.IO)

Flow: Desktop → QR Token Mobile → Scan → Approve Socket → JWT delivered

GET /auth/qr-generate

Response

{ "token": "qr_temp_token" }

Socket.IO Subscribe

const socket = io("https://opslinkservers-backend.onrender.com", { path: "/socket.io" });
socket.emit("subscribe-token", qrToken);
socket.on("qr-success", data => {
  console.log("JWT:", data.token);
});

---

🌐 Server Listings

GET /servers

Response

[
  { "_id": "server123", "name": "OpsLink Hub", "tags": ["gaming", "tech"], "rating": 4.9, "approved": true }
]

POST /servers Auth Required

Request

{ "name": "My Server", "description": "Community server", "tags": ["community"] }

---

⭐ Reviews

POST /servers/:id/reviews Auth Required

Request

{ "rating": 5, "comment": "Amazing server" }

---

🛠 Admin API

PATCH /admin/servers/:id/status Admin

Request

{ "status": "approved" }

---

📦 SDKs

JavaScript

opslink.js

class OpsLink {
  constructor(token) {
    this.token = token;
    this.base = 'https://opslinkservers-backend.onrender.com/api';
  }
  async getServers() {
    return fetch(`${this.base}/servers`).then(r => r.json());
  }
  async submitServer(data) {
    return fetch(`${this.base}/servers`, {
      method: 'POST',
      headers: {
        'Authorization': `Bearer ${this.token}`,
        'Content-Type': 'application/json'
      },
      body: JSON.stringify(data)
    }).then(r => r.json());
  }
}

Python

---

🚦 Rate Limits

• Auth: 10 req/min

• General API: 60 req/min

• QR Login: 5 req/min

---

🚨 Errors

{ "error": "Unauthorized" }

Status Codes

• 400 – Bad Request

• 401 – Unauthorized

• 403 – Forbidden

• 404 – Not Found

• 500 – Server Error

---

🔐 Security

• JWT validation

• CORS allowlist

• Socket room isolation

---

✅ You Are Done

This documentation is production-ready and public-facing.