SharePanel API Documentation

Rate Limiting

Rate limits are enforced based on your plan:

Authentication

Generate a new API key by authenticating with your email and password.

{
  "status": "success",
  "message": "Authentication successful",
  "data": {
    "api_key": "your_api_key_here"
  }
}

User Profile

Manage your user profile information.

{
  "status": "success",
  "message": "Profile retrieved successfully",
  "timestamp": "2024-01-01T12:00:00+00:00",
  "data": {
    "id": 123,
    "username": "username",
    "email": "user@example.com",
    "bio": "User bio",
    "pfp": "profile_picture_url",
    "plan": "pro",
    "org_limit": 10,
    "instance_limit": 25,
    "verified": 1,
    "balance": 100.00,
    "first_name": "John",
    "last_name": "Doe",
    "phone": "1234567890",
    "address": "123 Main St"
  }
}

{
  "status": "success",
  "message": "Profile updated successfully",
  "timestamp": "2024-01-01T12:00:00+00:00"
}

{
  "status": "success",
  "message": "Statistics retrieved successfully",
  "timestamp": "2024-01-01T12:00:00+00:00",
  "data": {
    "org_count": 5,
    "instance_count": 12,
    "active_instances": 8,
    "invoice_count": 15,
    "total_spent": 250.00
  }
}

Organizations

Manage your organizations with the following endpoints.

{
  "status": "success",
  "message": "Organizations retrieved successfully",
  "data": [
    {
      "id": 1,
      "title": "Organization Name",
      "path": "organization-name",
      "admin_id": 123,
      "contact": "contact@example.com",
      "created_by": 123
    }
  ]
}

{
  "status": "success",
  "message": "Organization created successfully",
  "data": {
    "org_id": 1
  }
}

{
  "status": "success",
  "message": "Organization retrieved successfully",
  "data": {
    "id": 1,
    "title": "Organization Name",
    "member_count": 5,
    "instance_count": 3
  }
}

Instances

Manage your instances with the following endpoints.

{
  "status": "success",
  "message": "Instances retrieved successfully",
  "timestamp": "2024-01-01T12:00:00+00:00",
  "data": [
    {
      "id": 1,
      "instance_name": "Instance Name",
      "instance_path": "instance-path",
      "created_at": "2023-01-01 12:00:00",
      "status": "active",
      "instance_type": "default",
      "type": "SNCS"
    }
  ]
}

{
  "status": "success",
  "message": "3 dead instances deleted successfully"
}

{
  "status": "success",
  "message": "5 instances awakened successfully"
}

{
  "status": "success",
  "message": "5 instances put to sleep successfully"
}

Billing

Manage billing, invoices, transactions, and purchases.

{
  "status": "success",
  "data": {
    "balance": 100.50,
    "currency": "USD"
  }
}

Analytics

Get analytics and usage statistics for your account.

Notifications

Manage your notifications.

API Keys

Manage your API keys.

Statistics

Get overview statistics for your account.

Search

Search across your organizations and instances.

{
  "status": "success",
  "message": "Search completed successfully",
  "data": [
    {
      "type": "organization",
      "id": 1,
      "name": "My Organization",
      "path": "my-organization"
    }
  ]
}

Error Handling

All API errors will return a JSON response with a status of "error" and a message explaining the error.

{
  "status": "error",
  "message": "Error message here"
}

Common error messages include:

• "Invalid or expired API key"
• "Rate limit exceeded. Please try again later."
• "Email and password are required"
• "Invalid email or password"
• "Organization ID is required"
• "You do not have permission to delete this organization"
• "Organization limit reached for your plan"
• "Invalid mode. Available modes: auth, profile, orgs, instances, billing, analytics, notifications, api_keys, search, stats"
• "Invalid action for [mode] mode"

Code Examples

PHP Example

// Authenticate
$email = "user@example.com";
$password = "password";
$authUrl = "https://api.sharepanel.host/?mode=auth&email=" . urlencode($email) . "&password=" . urlencode($password);
$response = file_get_contents($authUrl);
$data = json_decode($response, true);
$apiKey = $data['data']['api_key'];

// Get profile
$profileUrl = "https://api.sharepanel.host/?mode=profile&apikey=" . urlencode($apiKey) . "&action=view";
$response = file_get_contents($profileUrl);
$profile = json_decode($response, true);

Python Example

import requests

# Authenticate
email = "user@example.com"
password = "password"
auth_url = f"https://api.sharepanel.host/?mode=auth&email={email}&password={password}"
response = requests.get(auth_url)
data = response.json()
apikey = data['data']['api_key']

# Get profile
profile_url = f"https://api.sharepanel.host/?mode=profile&apikey={apikey}&action=view"
response = requests.get(profile_url)
profile = response.json()

JavaScript Example

// Authenticate
const email = "user@example.com";
const password = "password";
const authUrl = `https://api.sharepanel.host/?mode=auth&email=${encodeURIComponent(email)}&password=${encodeURIComponent(password)}`;

fetch(authUrl)
  .then(response => response.json())
  .then(data => {
    const apiKey = data.data.api_key;
    
    // Get profile
    const profileUrl = `https://api.sharepanel.host/?mode=profile&apikey=${encodeURIComponent(apiKey)}&action=view`;
    return fetch(profileUrl);
  })
  .then(response => response.json())
  .then(profile => {
    console.log(profile);
  });

Best Practices

Security

• Store API Keys Securely: Never commit API keys to version control. Use environment variables or secure storage.
• Use HTTPS: Always use HTTPS for API requests to protect sensitive data.
• Rotate Keys Regularly: Periodically regenerate API keys for enhanced security.

Error Handling

• Always Check Response Status: Verify the response status before processing data.
• Handle Errors Gracefully: Implement proper error handling for all API calls.
• Log Errors: Log API errors for debugging and monitoring.

Rate Limiting

• Monitor Rate Limits: Check rate limit headers in responses.
• Implement Exponential Backoff: Retry failed requests with exponential backoff when rate limited.
• Cache Responses: Cache API responses when appropriate to reduce API calls.

Performance

• Validate Input: Validate all parameters before sending API requests.
• Use Appropriate HTTP Methods: Use GET for retrieval, POST for creation when available.
• Minimize Requests: Batch operations when possible to reduce API calls.

Support

If you have any questions or need assistance with the SharePanel API, please contact our support team at support@sharepanel.host.

For comprehensive documentation including user guides, admin guides, and feature documentation, visit the Staff Documentation Portal.