SOP-001: API Authentication

Fresh

Field	Value
Document ID	SOP-001
Version	1.0
Status	Active
Last Updated	2025-01-08

Overview

This procedure explains how to authenticate with the Proxidize API using token-based authentication. All API endpoints require valid authentication.

Prerequisites

• Active Proxidize subscription (Essential, Plus, or Business)
• Access to Proxidize dashboard
• Network access to Proxidize server

Procedure

Step 1: Locate Your API Token

1. Log into your Proxidize dashboard
2. Click Settings in the navigation
3. Find the API Token section
4. Click Copy to copy your token

Step 2: Format the Authorization Header

The token must be included in the HTTP Authorization header with this exact format:

Authorization: Token YOUR_API_TOKEN

Important

• The word "Token" must be capitalized
• There must be a single space between "Token" and your actual token
• Do not include quotes around the token

Step 3: Make an Authenticated Request

Using cURL:

curl -H "Authorization: Token abc123xyz789" \
     http://192.168.1.100/api/getinfo

Using JavaScript (fetch):

const response = await fetch('http://192.168.1.100/api/getinfo', {
  headers: {
    'Authorization': 'Token abc123xyz789'
  }
});
const data = await response.json();

Using Python (requests):

import requests

headers = {'Authorization': 'Token abc123xyz789'}
response = requests.get('http://192.168.1.100/api/getinfo', headers=headers)
data = response.json()

Verification Checklist

• [ ] API token copied from dashboard
• [ ] Authorization header formatted correctly
• [ ] Test request returns JSON (not error)
• [ ] Token stored securely (not in code)

Troubleshooting

Issue	Cause	Solution
401 Unauthorized	Invalid or missing token	Verify token is correct and header format
403 Forbidden	Plan doesn't support endpoint	Check plan access levels
Connection refused	Server unreachable	Verify server IP and network access

See Also

• Quick Start Guide
• API Endpoints Reference
• Plan Comparison