DokuWiki

It's better when it's simple

User Tools

Site Tools


devel:xmlrpc

XML-RPC

XML-RPC is one of the available protocols to access DokuWiki's Remote API, modern implementations will probably prefer using the JSON-RPC API which provides the same functionality but is based on JSON rather XML.

Please refer to the main Remote API page on how to enable the API functionality, how authentication works and which methods are available.

Accessing The XML-RPC Interface

You can access the XML-RPC interface via the following URLs:

http(s)://<your wiki>/lib/exe/xmlrpc.php

Refer to authentication on how to authenticate API requests.

Sample XML Requests

You should use an XML-RPC library instead of hand-crafting your requests.

Here are some simple examples of how to post to the API. Please refer to the XML-RPC for more details on the protocol.

POST /RPC2 HTTP/1.0
Host: example.com
Content-Type: text/xml
 
<?xml version="1.0"?>
<methodCall>
    <methodName>core.getWikiVersion</methodName>
</methodCall>

Here's the call to save new page content as a minor edit:

<?xml version="1.0"?>
<methodCall>
    <methodName>core.savePage</methodName>
    <params>
        <param> 
            <value>
                <string>mynamespace:mypage</string>
            </value>
        </param> 
        <param> 
            <value>
                <string>This is my page content</string>
            </value>
        </param>
        <param> 
            <value>
                <string>The summary for this minor edit</string>
            </value>
        </param>
        <param> 
            <value>
                <boolean>True</boolean>
            </value>
        </param>
    </params> 
</methodCall>

Sample Clients

A number of clients written in different languages are available.

devel/xmlrpc.txt · Last modified: by andi

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki