API Documentation

API Overview

The Web Defender API allows you to integrate our security features into your applications, automate security operations, and access your security data programmatically. Our RESTful API uses standard HTTP methods and returns JSON responses.

Base URL

https://api.webdefender.online/v1

API Versioning

The Web Defender API is versioned to ensure backward compatibility. The current version is v1. When a new version is released, the previous version will be supported for at least 12 months.

Content Type

All requests should include the Content-Type: application/json header. Responses will also be in JSON format.

Authentication

All API requests must be authenticated using an API key. You can generate an API key in the Web Defender dashboard under Settings > API.

API Key Authentication

Include your API key in the Authorization header of your requests:

Authorization: Bearer YOUR_API_KEY

Example Request

curl -X GET "https://api.webdefender.online/v1/websites" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json"

Rate Limits

To ensure the stability and availability of the API, we enforce rate limits on API requests. The rate limits vary based on your subscription plan.

Rate Limit Headers

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

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 297
X-RateLimit-Reset: 1620000000

• X-RateLimit-Limit: The maximum number of requests you can make per minute
• X-RateLimit-Remaining: The number of requests remaining in the current minute
• X-RateLimit-Reset: The time at which the rate limit will reset, in Unix time

Exceeding Rate Limits

If you exceed the rate limit, you'll receive a 429 Too Many Requests response. The response will include a Retry-After header indicating how many seconds to wait before making another request.

Error Handling

The Web Defender API uses standard HTTP status codes to indicate the success or failure of a request. In addition to the status code, error responses include a JSON body with more information about the error.

Error Response Format

{
  "error": {
    "code": "invalid_request",
    "message": "The request was invalid",
    "details": "The 'website_id' parameter is required"
  }
}

Common Error Codes

Handling Errors

When handling errors in your application, we recommend checking both the HTTP status code and the error code in the response body. This will give you more detailed information about what went wrong and how to fix it.

try {
  const response = await fetch('https://api.webdefender.online/v1/websites', {
    headers: {
      'Authorization': `Bearer ${apiKey}`,
      'Content-Type': 'application/json'
    }
  });
  
  if (!response.ok) {
    const error = await response.json();
    throw new Error(`${response.status}: ${error.error.message}`);
  }
  
  const data = await response.json();
  // Process data
} catch (error) {
  console.error('API Error:', error.message);
}

Websites API

The Websites API allows you to manage the websites protected by Web Defender. You can list, create, update, and delete websites, as well as configure their protection settings.

List Websites

Retrieve a list of all websites protected by Web Defender.

GET /websites

Example Request

curl -X GET "https://api.webdefender.online/v1/websites" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json"

Example Response

{
  "data": [
    {
      "id": "ws_123456",
      "domain": "example.com",
      "protocol": "https",
      "created_at": "2023-01-15T12:00:00Z",
      "protection_level": "standard",
      "status": "active"
    },
    {
      "id": "ws_789012",
      "domain": "another-example.com",
      "protocol": "https",
      "created_at": "2023-02-20T15:30:00Z",
      "protection_level": "high",
      "status": "active"
    }
  ],
  "meta": {
    "total": 2,
    "per_page": 10,
    "current_page": 1,
    "last_page": 1
  }
}

Create Website

Add a new website to Web Defender for protection.

POST /websites

Request Parameters

Example Request

curl -X POST "https://api.webdefender.online/v1/websites" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "domain": "new-example.com",
       "protocol": "https",
       "protection_level": "standard"
     }'

Example Response

{
  "data": {
    "id": "ws_345678",
    "domain": "new-example.com",
    "protocol": "https",
    "created_at": "2023-06-10T09:45:00Z",
    "protection_level": "standard",
    "status": "active"
  }
}