Integration

Welcome to the Jarvis Developer Platform. This guide will help you create an API token, authenticate requests, understand API responses and begin integrating Jarvis APIs into your applications.

1. Creating an API Token

API tokens can be generated from your Jarvis profile page. Each token is linked to your account and rate limits are applied based on your subscription plan.

1. Log in to your Jarvis with discord.
2. Click your profile picture (located top right).
3. Click on your name.
4. Generate your token.
5. Save your token securely.

2. Making Your First Request

Once you have an API token, include it in the request headers.

Example: Random Joke

GET /api/jokes/random

curl \
-H "Authorization: YOUR_API_TOKEN" \
https://jarvisbot.uk/api/jokes/random

fetch("https://jarvisbot.uk/api/jokes/random", {
    headers: {
        "Authorization": "YOUR_API_TOKEN"
    }
})
.then(response => response.json())
.then(console.log);

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => "https://jarvisbot.uk/api/jokes/random",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: YOUR_API_TOKEN"
    ]
]);

$response = curl_exec($ch);
$data = json_decode($response, true);

curl_close($ch);

3. Understanding Responses

All API responses are returned as JSON.

Example Successful Response

{
    "id": 42,
    "setup": "Why do programmers prefer dark mode?",
    "punchline": "Because light attracts bugs."
}

Most endpoints will return a JSON object or a JSON array depending on the operation being performed.

Example Collection Response

[
    {
        "id": 1,
        "name": "Accio"
    },
    {
        "id": 2,
        "name": "Lumos"
    }
]

4. Authentication Overview

Every API request must include an API token.

Recommended Header

Authorization: YOUR_API_TOKEN

Alternative Header

X-API-Token: YOUR_API_TOKEN

Query String (Not Recommended)

GET /api/flags/random?token=YOUR_API_TOKEN

Account Plans & Rate Limits

5. Common Error Codes

Jarvis APIs use consistent error formats to help identify issues quickly.

{
    "success": false,
    "error": "invalidToken",
    "msg": "API token required"
}

{
    "success": false,
    "error": "invalidToken",
    "msg": "Invalid API token"
}

{
    "success": false,
    "error": "rateLimit",
    "msg": "API limit exceeded",
    "plan": "free",
    "limit": 100
}

{
    "success": false,
    "error": "notFound",
    "msg": "Resource not found"
}

Available APIs