API Authentication

Overview

All DeskForge API requests require authentication using an API key. API keys are associated with your account and can be created and managed from your dashboard.

Getting an API Key

Follow these steps to generate a new API key:

1. Log in to your DeskForge Dashboard at deskforge.app/dashboard
2. Navigate to Settings → Access Tokens
3. Click Generate New Token
4. Give your token a descriptive name (e.g., "Production API", "CI/CD Pipeline")
5. Copy the token immediately - you won't be able to see it again
6. Store the token securely (e.g., in environment variables or a secrets manager)

Using Your API Key

Include your API key in the Authorization header of every request:

Authorization: Bearer YOUR_API_KEY

Example Request

curl -X GET https://api.deskforge.app/projects \
  -H "Authorization: Bearer df_1234567890abcdef" \
  -H "Content-Type: application/json"

Code Examples

JavaScript / Node.js

const axios = require('axios');

const client = axios.create({
  baseURL: 'https://api.deskforge.app',
  headers: {
    'Authorization': `Bearer ${process.env.DESKFORGE_API_KEY}`,
    'Content-Type': 'application/json'
  }
});

// Make authenticated requests
const response = await client.get('/projects');
console.log(response.data);

Python

import os
import requests

API_KEY = os.getenv('DESKFORGE_API_KEY')
BASE_URL = 'https://api.deskforge.app'

headers = {
    'Authorization': f'Bearer {API_KEY}',
    'Content-Type': 'application/json'
}

response = requests.get(f'{BASE_URL}/projects', headers=headers)
projects = response.json()
print(projects)

Go

package main

import (
    "fmt"
    "io"
    "net/http"
    "os"
)

func main() {
    apiKey := os.Getenv("DESKFORGE_API_KEY")
    
    req, _ := http.NewRequest("GET", "https://api.deskforge.app/projects", nil)
    req.Header.Add("Authorization", "Bearer "+apiKey)
    req.Header.Add("Content-Type", "application/json")
    
    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()
    
    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}

API Key Management

Rotating Keys

For security best practices, rotate your API keys periodically:

1. Generate a new API key
2. Update your applications to use the new key
3. Verify the new key works correctly
4. Delete the old key from your dashboard

Revoking Keys

If an API key is compromised, revoke it immediately:

1. Go to Settings → Access Tokens
2. Find the compromised key
3. Click Revoke
4. Generate a new key and update your applications

Authentication Error Responses

Missing API Key

HTTP/1.1 401 Unauthorized

{
  "error": "Authentication required",
  "message": "No API key provided"
}

Invalid API Key

HTTP/1.1 401 Unauthorized

{
  "error": "Invalid API key",
  "message": "The provided API key is invalid or has been revoked"
}

Expired API Key

HTTP/1.1 401 Unauthorized

{
  "error": "API key expired",
  "message": "Your API key has expired. Please generate a new one"
}