Welcome to the DocConvert API documentation. Our API provides a comprehensive set of endpoints for document conversion, manipulation, and processing. This documentation will help you integrate our services into your applications.

The API is RESTful and uses JSON for request and response bodies. All requests must be made over HTTPS and include proper authentication.

File uploads are handled directly in each operation endpoint. When making a request, include the file as a multipart form-data field named file along with any other required parameters for the specific operation.

To get started with the API, you'll need:

1. An API key from your API Settings in the account settings area
2. Basic understanding of REST APIs
3. Ability to make HTTP requests

curl -X POST https://docconvert.co/api/v1/docx_to_pdf \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "[email protected]"

All API requests require authentication using an API key. Include your API key in the X-API-Key header of each request:

X-API-Key: YOUR_API_KEY

You can find your API key in the API Settings section of your account settings. Keep your API key secure and never share it publicly.

Webhooks allow you to receive real-time notifications when your file processing jobs are completed. You can manage your webhooks in the Webhook Settings section of your Account Settings. To set up a webhook:

1. Navigate to Account Settings and select Webhook Settings
2. Click "Add New Webhook" and enter your webhook URL
3. Select which events you want to receive notifications for
4. Copy your webhook client secret for signature verification

{
  "event": "completed",
  "object_id": "123",
  "timestamp": "2024-03-20T12:00:00Z"
}

require 'openssl'

def verify_signature(payload_body, signature, client_secret)
  digest = OpenSSL::Digest::SHA256.new('sha256')
  expected_signature = OpenSSL::HMAC.hexdigest(
    digest,
    client_secret,
    payload_body
  )

  Rack::Utils.secure_compare(expected_signature, signature)
end

# In your webhook handler
signature = request.headers['X-Signature']
is_valid = verify_signature(request.raw_post, signature, webhook_client_secret)

import hmac
import hashlib

def verify_signature(payload_body, signature, client_secret):
    expected_signature = hmac.new(
        client_secret.encode('utf-8'),
        payload_body.encode('utf-8'),
        hashlib.sha256
    ).hexdigest()

    return hmac.compare_digest(expected_signature, signature)

# In your webhook handler (using Flask)
signature = request.headers.get('X-Signature')
is_valid = verify_signature(request.get_data().decode('utf-8'), signature, webhook_client_secret)

const crypto = require('crypto');

function verifySignature(payloadBody, signature, clientSecret) {
  const expectedSignature = crypto
    .createHmac('sha256', clientSecret)
    .update(payloadBody)
    .digest('hex');

  return crypto.timingSafeEqual(
    Buffer.from(expectedSignature),
    Buffer.from(signature)
  );
}

// In your webhook handler (using Express)
const signature = req.headers['x-signature'];
const isValid = verifySignature(
  JSON.stringify(req.body),
  signature,
  webhookClientSecret
);

function verifySignature($payloadBody, $signature, $clientSecret) {
    $expectedSignature = hash_hmac(
        'sha256',
        $payloadBody,
        $clientSecret
    );

    return hash_equals($expectedSignature, $signature);
}

// In your webhook handler
$signature = $_SERVER['HTTP_X_SIGNATURE'];
$payloadBody = file_get_contents('php://input');
$isValid = verifySignature($payloadBody, $signature, $webhookClientSecret);

API access is available only with paid subscription plans. Rate limits are based on your subscription tier:

• Pro: 1,000 requests per day
• Team: Custom limits

In addition to daily limits, all API requests are limited to 10 requests per second to ensure fair usage and system stability.

The API uses standard HTTP response codes and returns error messages in the response body:

{
  "code": 400,
  "message": "Bad Request",
  "errors": [
    "The provided file is not in a supported format",
    "File size exceeds maximum limit"
  ]
}

Common error codes:

• 400 - Bad Request
• 401 - Unauthorized
• 403 - Forbidden
• 404 - Not Found
• 429 - Too Many Requests
• 500 - Internal Server Error