DokuWiki

It's better when it's simple

User Tools

Site Tools

Trace:
devel:xmlrpc

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
Next revisionBoth sides next revision
devel:xmlrpc [2018-05-09 18:01] – move samples to separated page Klap-indevel:xmlrpc [2018-05-29 13:48] – andi
Line 1: Line 1:
 ====== XML-RPC ====== ====== XML-RPC ======
-[[:experimental]] 
  
-DokuWiki has an experimental [[wp>XML-RPC]] API which can be used to access/interact with your wiki from other applications. The API implements the [[http://www.ecyrd.com/JSPWiki/wiki/WikiRPCInterface2|Wiki RPC Interface 2.0 Specifications]] in the ''wiki.*'' namespace and adds additional DokuWiki specific calls in the ''dokuwiki.*'' namespace. See [[custom_webservices|web services]] for some general notes about DokuWikis possibilities.+DokuWiki has a [[wp>XML-RPC]] API which can be used to access/interact with your wiki from other applications. The API implements the [[http://www.ecyrd.com/JSPWiki/wiki/WikiRPCInterface2|Wiki RPC Interface 2.0 Specifications]] in the ''wiki.*'' namespace and adds additional DokuWiki specific calls in the ''dokuwiki.*'' namespace. See [[custom_webservices|web services]] for some general notes about DokuWikis possibilities. 
 + 
 +Plugins can add their own calls to the API using [[devel:remote_plugins|Remote Plugin components]].
  
 Questions and suggestions to extend and improve the API should be directed to the [[:mailinglist]]. Questions and suggestions to extend and improve the API should be directed to the [[:mailinglist]].
Line 20: Line 21:
  
 ===== Sample XML Requests ===== ===== Sample XML Requests =====
 +
 +Note: you should use an XML-RPC library instead of hand-crafting your requests.
 +
 Here is an example of how to post to the API: Here is an example of how to post to the API:
 +
 <code xml> <code xml>
 POST /RPC2 HTTP/1.0 POST /RPC2 HTTP/1.0
Line 63: Line 68:
  <param>   <param> 
  <value>  <value>
- <string>======  Devices List ====== + <string>This is my page content</string>
-Report Created on 2017-05-25 16:23:37 +
-===== Servers ===== +
-^ID ^Name ^Description ^IP ^Type ^OS ^Last Scan ^ +
-|18 |[[:inventory:devices:Computer:adminserver ID-18|adminserver]] |AT/AT COMPATIBLE |192.168.1.1 |Server |Microsoft Windows 2000 Server |2017-05-25 16:09:10 | +
- +
- </string>+
  </value>  </value>
  </param>  </param>
Line 163: Line 162:
 ^ Description | Allows you to lock or unlock a whole bunch of pages at once. Useful when you are about to do an operation over multiple pages. | ^ Description | Allows you to lock or unlock a whole bunch of pages at once. Useful when you are about to do an operation over multiple pages. |
 ^ Since       | 2009-03-06 (1) | ^ Since       | 2009-03-06 (1) |
 +
 +==== dokuwiki.deleteUsers ====
 +
 +^ Name        | ''dokuwiki.deleteUsers'' |
 +^ Parameters  | (array) list of usernames to delete |
 +^ Data        | (bool) true if the users were deleted |
 +^ Description | Allows you to delete one or more users. Useful to implement GDPR right to be forgotten tools. |
 +^ Since       | 2018-05-24 |
  
 ==== wiki.getRPCVersionSupported ==== ==== wiki.getRPCVersionSupported ====
devel/xmlrpc.txt · Last modified: 2024-01-31 23:57 by Klap-in
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

Global DokuWiki Links