API Integration

Understanding API Integration

Ahmed Rehan Documentation provides robust API integration capabilities that allow you to automate documentation processes and keep content synchronized with your development workflow. Whether you're pulling in API specifications, updating content from code repositories, or triggering builds on documentation changes, our API endpoints make it possible.

Getting Started with the API

To use the Ahmed Rehan Documentation API, you first need to generate an API key from your account settings. This key provides authenticated access to all API endpoints.

# Generate a new API key
curl -X POST https://api.ahmedrehan.com/auth/keys \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Documentation Sync","permissions":["read","write"]}'

import requests

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

key_data = {
  'name': 'Auto Sync Service',
  'permissions': ['read', 'write', 'delete']
}

response = requests.post(
  'https://api.ahmedrehan.com/auth/keys',
  headers=headers,
  json=key_data
)

api_key = response.json()['key']

Webhook Configuration

Webhooks allow you to receive real-time notifications when documentation events occur, enabling automated workflows and integrations.

{
  "event": "document.updated",
  "timestamp": "2024-01-15T10:30:00Z",
  "project": {
    "id": "proj_123",
    "name": "API Documentation"
  },
  "document": {
    "id": "doc_456",
    "path": "api-reference/authentication.mdx",
    "version": "1.2.0"
  },
  "changes": {
    "author": "jane.doe@company.com",
    "summary": "Updated authentication flow diagram"
  }
}

# Register webhook endpoint
curl -X POST https://api.ahmedrehan.com/webhooks \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-app.com/webhooks/docs",
    "events": ["document.updated", "project.created"],
    "secret": "your_webhook_secret"
  }'

const crypto = require('crypto');

function verifyWebhook(payload, signature, secret) {
  const expectedSignature = crypto
    .createHmac('sha256', secret)
    .update(payload)
    .digest('hex');
  
  return crypto.timingSafeEqual(
    Buffer.from(signature, 'hex'),
    Buffer.from(expectedSignature, 'hex')
  );
}

// In your webhook handler
app.post('/webhooks/docs', (req, res) => {
  const isValid = verifyWebhook(
    JSON.stringify(req.body),
    req.headers['x-webhook-signature'],
    process.env.WEBHOOK_SECRET
  );
  
  if (!isValid) {
    return res.status(401).send('Invalid signature');
  }
  
  // Process the webhook
  handleDocumentationUpdate(req.body);
  res.sendStatus(200);
});

import hmac
import hashlib
import json

def verify_webhook(payload, signature, secret):
  expected = hmac.new(
    secret.encode(),
    json.dumps(payload, separators=(',', ':')).encode(),
    hashlib.sha256
  ).hexdigest()
  
  return hmac.compare_digest(signature, expected)

# Flask webhook handler
@app.route('/webhooks/docs', methods=['POST'])
def handle_webhook():
  payload = request.get_json()
  signature = request.headers.get('X-Webhook-Signature')
  
  if not verify_webhook(payload, signature, os.getenv('WEBHOOK_SECRET')):
    abort(401)
    
  process_docs_update(payload)
  return '', 200

SDK Libraries

Use our official SDK libraries to simplify API integration and reduce development time.

npm install @ahmedrehan/docs-sdk

const { AhmedRehanDocs } = require('@ahmedrehan/docs-sdk');

const client = new AhmedRehanDocs({
  apiKey: process.env.DOCS_API_KEY
});

// Sync documentation from GitHub
await client.projects('my-project').documents.sync({
  source: 'github',
  repo: 'company/docs',
  branch: 'main'
});