API Documentation

Introduction

Welcome to the Technified API documentation. This API allows you to seamlessly connect Discord and Roblox profiles, enabling verification and synchronization between the two platforms. With our robust set of endpoints, you can build powerful integrations that enhance user experience across your Discord servers and Roblox games.

Base URL

All API requests should be made to the following base URL:

https://technified.xyz/api

API Version

The current version of the API is v1. We recommend specifying the version in your requests to ensure compatibility with future updates.

Authentication

All API requests require authentication using an API key. This key must be included in the headers of each request to identify your application and apply appropriate rate limits.

API Key

Include your API key in the Api-Key header with every request:

Api-Key: your_api_key_here

Obtaining an API Key

API keys are issued to verified partners. To request an API key, please reach out to our team through the Technified Discord server.

Error Handling

The API uses conventional HTTP response codes to indicate the success or failure of requests. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that resulted from the provided information, and codes in the 5xx range indicate an error with our servers.

HTTP Status Codes

Error Response Format

When an error occurs, the API returns a JSON object with an error field containing a human-readable message:

{
  "error": "Invalid API key"
}

Rate Limits

To ensure the stability and availability of the API for all users, rate limits are applied based on your API key. If you exceed these limits, you'll receive a 429 Too Many Requests response.

Default Limits

The default rate limits are:

• 100 requests per minute
• 5,000 requests per day

Headers

Each response includes headers that provide information about your current rate limit status:

Users

The Users endpoints allow you to manage user verification between Discord and Roblox platforms.

{
  "users": [
    {
      "id": 123,
      "roblox_id": "12345678",
      "roblox_username": "RobloxUser123",
      "discord_id": "123456789012345678",
      "discord_username": "DiscordUser#1234",
      "verified_at": "2025-04-01T12:34:56.789Z",
      "metadata": { "role": "member" }
    },
    // More users...
  ],
  "pagination": {
    "total": 250,
    "page": 1,
    "limit": 100,
    "pages": 3,
    "hasNext": true,
    "hasPrev": false
  }
}

{
  "user": {
    "id": 123,
    "roblox_id": "12345678",
    "roblox_username": "RobloxUser123",
    "discord_id": "123456789012345678",
    "discord_username": "DiscordUser#1234",
    "verified_at": "2025-04-01T12:34:56.789Z",
    "metadata": { "role": "member" }
  }
}

{
  "success": true,
  "message": "User deleted",
  "changes": 1
}

Verification

The Verification endpoints allow you to create and verify connections between Discord and Roblox accounts.

{
  "robloxId": "12345678",
  "robloxUsername": "RobloxUser123",
  "discordId": "123456789012345678",
  "discordUsername": "DiscordUser#1234",
  "metadata": {
    "role": "member",
    "group": "developers",
    "notes": "Joined through website referral"
  }
}

{
  "success": true,
  "message": "Verification successful",
  "userId": 123
}

{
  "verified": true,
  "user": {
    "id": 123,
    "robloxId": "12345678",
    "robloxUsername": "RobloxUser123",
    "discordId": "123456789012345678",
    "discordUsername": "DiscordUser#1234",
    "verifiedAt": "2025-04-01T12:34:56.789Z",
    "metadata": {
      "role": "member"
    }
  }
}

Statistics

The Statistics endpoints provide insights into the verification system's usage and trends.

{
  "totalUsers": 1257,
  "last24Hours": 42,
  "last7Days": 189,
  "last30Days": 563,
  "verificationsByDay": [
    {
      "date": "2025-04-05",
      "count": 23
    },
    {
      "date": "2025-04-06",
      "count": 31
    },
    {
      "date": "2025-04-07",
      "count": 27
    },
    {
      "date": "2025-04-08",
      "count": 19
    },
    {
      "date": "2025-04-09",
      "count": 35
    },
    {
      "date": "2025-04-10",
      "count": 29
    },
    {
      "date": "2025-04-11",
      "count": 25
    }
  ],
  "generatedAt": "2025-04-11T15:23:47.123Z"
}

Statistics Fields

Audit Logs

The Audit Logs feature allows you to track all important actions performed within the system for security and compliance purposes.

{
  "logs": [
    {
      "id": 456,
      "event_type": "user_verified",
      "user_id": 123,
      "roblox_id": "12345678",
      "discord_id": "123456789012345678",
      "details": "{"robloxUsername":"RobloxUser123","discordUsername":"DiscordUser#1234"}",
      "ip_address": "192.168.1.1",
      "created_at": "2025-04-11T14:32:17.123Z"
    },
    {
      "id": 455,
      "event_type": "user_deleted",
      "user_id": 122,
      "roblox_id": "87654321",
      "discord_id": "876543210987654321",
      "details": "{"robloxUsername":"DeletedUser","discordUsername":"FormerUser#5678"}",
      "ip_address": "192.168.1.2",
      "created_at": "2025-04-11T13:45:21.456Z"
    },
    // More logs...
  ],
  "pagination": {
    "total": 1250,
    "page": 1,
    "limit": 100,
    "pages": 13,
    "hasNext": true,
    "hasPrev": false
  }
}

Audit Event Types

The system logs various event types to track different actions in the system:

Data Retention

Audit logs are kept for a period of 365 days, after which they are automatically purged from the system. If you need to retain audit logs for longer periods, we recommend implementing a process to export and archive these logs on a regular basis.

Discord Integration

Learn how to integrate the Technified API with your Discord bot for seamless verification between Discord and Roblox.

Roblox Integration

Learn how to integrate the Technified API with your Roblox game to verify users and sync roles.

Webhooks

Learn how to set up webhooks to receive real-time notifications for verification events.

Quick Start Guides

Learn from a quick starter guide how to use Technified.

Example Projects

Learn from Example Projects how to use Technified.