DokuWiki API and Integration — XML-RPC, JSON API, and External Integration

#!/usr/bin/env python3
# api-example.py - Interact with DokuWiki API

import xmlrpc.client

# Connection
url = "https://yourserver/wiki/lib/exe/xmlrpc.php"
username = "apiuser"
password = "apipassword"

server = xmlrpc.client.ServerProxy(url)

# Authenticate
try:
    # List all pages in a namespace
    pages = server.wiki.listPages(username, password)
    for page in pages:
        print(f"{page['id']} - {page['title']} - {page['lastModified']}")

    # Get page content
    content = server.wiki.getPage(username, password, "start")
    print(f"\nStart page content:\n{content}")

    # Create/update a page
    new_content = "====== API Test ======\n\nThis page was created via the API."
    result = server.wiki.putPage(
        username, password,
        "api-test",
        new_content,
        {"sum": "Created via API"}
    )
    print(f"\nPage created: {result}")

except xmlrpc.client.Fault as err:
    print(f"Error: {err.faultString}")

except xmlrpc.client.ProtocolError as err:
    print(f"Protocol error: {err.errmsg}")

<?php
// api-example.php

$url = 'https://yourserver/wiki/lib/exe/xmlrpc.php';
$username = 'apiuser';
$password = 'apipassword';

$request = xmlrpc_encode_request('wiki.getPage', array($username, $password, 'start'));

$context = stream_context_create(array(
    'http' => array(
        'method' => 'POST',
        'header' => 'Content-Type: text/xml',
        'content' => $request,
    ),
));

$response = file_get_contents($url, false, $context);
$result = xmlrpc_decode($response);

echo "Start page content:\n" . $result . "\n";

# Get page content via XML-RPC
curl -X POST https://yourserver/wiki/lib/exe/xmlrpc.php \
  -H "Content-Type: text/xml" \
  -d '<?xml version="1.0"?>
  <methodCall>
    <methodName>wiki.getPage</methodName>
    <params>
      <param><value><string>apiuser</string></value></param>
      <param><value><string>apipassword</string></value></param>
      <param><value><string>start</string></value></param>
    </params>
  </methodCall>'

cd /var/www/html/wiki/lib/plugins/
wget https://github.com/username/dokuwiki-plugin-jsonapi/archive/master.zip
unzip master.zip
mv dokuwiki-plugin-jsonapi-master jsonapi

# Get page content as JSON
curl "https://yourserver/wiki/lib/exe/json.php?page=start"

# Create page via JSON
curl -X POST "https://yourserver/wiki/lib/exe/json.php" \
  -H "Content-Type: application/json" \
  -d '{"method": "putPage", "params": ["apiuser","apipassword","api-test","Page content","API test"]}'

cd /var/www/html/wiki/lib/plugins/
wget https://github.com/username/dokuwiki-plugin-webhook/archive/master.zip
unzip master.zip
mv dokuwiki-plugin-webhook-master webhook

<?php
// conf/local.php
$conf['plugin']['webhook']['url'] = 'https://hooks.slack.com/services/...';
$conf['plugin']['webhook']['events'] = 'page_save,page_delete,user_register';
$conf['plugin']['webhook']['timeout'] = 5;

<?php
class action_plugin_webhook extends DokuWiki_Action_Plugin {

    public function register(Doku_Event_Handler $controller) {
        $controller->register_hook(
            'COMMON_WIKIPAGE_SAVE',
            'AFTER',
            $this,
            'send_webhook'
        );
    }

    public function send_webhook($event, $param) {
        $data = $event->data;
        $payload = json_encode(array(
            'event' => 'page_save',
            'page' => $data['id'],
            'editor' => $data['editor'],
            'timestamp' => time(),
        ));

        $webhookUrl = $this->getConf('url');
        if ($webhookUrl) {
            $http = new DokuHTTPClient();
            $http->post($webhookUrl, $payload);
        }
    }
}

#!/usr/bin/env python3
# ci-cd-integration.py

import xmlrpc.client
import os

version = os.environ.get('CI_COMMIT_TAG', 'unknown')
project = os.environ.get('CI_PROJECT_NAME', 'unknown')

server = xmlrpc.client.ServerProxy('https://wiki.example.com/lib/exe/xmlrpc.php')

# Create deployment page
content = f"""====== Deployment: {project} v{version} ======

**Date:** $(date)
**Version:** {version}
**Deployed by:** CI/CD Pipeline

=== Changes ===

See changelog for details.

=== Verification ===

- [ ] Smoke tests passed
- [ ] Health check passed
"""

server.wiki.putPage('apiuser', 'apipassword',
    f'deployments:{project}-{version}',
    content,
    {'sum': f'Automated deployment documentation for {project} v{version}'}
)

print(f"Deployment page created: deployments:{project}-{version}")

<?php
function notify_slack($message) {
    $webhookUrl = 'https://hooks.slack.com/services/...';
    $payload = json_encode(array('text' => $message));

    $ch = curl_init($webhookUrl);
    curl_setopt($ch, CURLOPT_POST, 1);
    curl_setopt($ch, CURLOPT_POSTFIELDS, $payload);
    curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
    curl_exec($ch);
    curl_close($ch);
}

def update_status_page(service, status, details):
    server = xmlrpc.client.ServerProxy(API_URL)
    content = f"# {service}: {status}\n\n{details}"
    server.wiki.putPage(USER, PASS, f"status:{service}", content, {})

# conf/xmlrpc.htaccess
Order Deny,Allow
Deny from all
Allow from 192.168.0.0/16
Allow from 10.0.0.0/8

# Limit API requests
location /lib/exe/xmlrpc.php {
    limit_req zone=api burst=5 nodelay;
}