From 2f7ffaf11f9b7997f7ab89988f7be24034487b96 Mon Sep 17 00:00:00 2001 From: mistic100 Date: Thu, 20 Sep 2012 16:04:23 +0000 Subject: feature 2751: Redesign web API, webservices explorer git-svn-id: http://piwigo.org/svn/trunk@18079 68402e56-0260-453c-a942-63ccdbb3a9ee --- tools/ws.htm | 826 +++++++++++++++++++++++++++++++++-------------------------- 1 file changed, 468 insertions(+), 358 deletions(-) (limited to 'tools/ws.htm') diff --git a/tools/ws.htm b/tools/ws.htm index b6d7fbbf8..88ebe630a 100644 --- a/tools/ws.htm +++ b/tools/ws.htm @@ -1,402 +1,512 @@ - - + + -PWG web service explorer - - + + Piwigo web API (web-services) explorer + + + + + + -function dumpError(err) -{ - var s= 'Error '; - if ('string' === typeof err ) - s += err; - else - { - s += err.name+'
'; - s += err.message; - if (err.stack!=null) - {//mozilla only - s += '
'+ err.stack + '
'; - } - } - $("error").update(s); -} + + +
+

Piwigo web API (web-services) explorer

+
+ +
+

Available methods

+ + +
+ +
+ + + +
+ + +
+

+ API = Application Programming Interface.
+ This is the way other applications can communicate with Piwigo. This feature is also know as Web Services. +

+ +

Examples:

+
    +
  • Wordpress (web blog software) can display random photos from a Piwigo gallery in its sidebar
    • +
  • Lightroom (photo management software for desktop) can create albums and upload photos to Piwigo
    • +
-var gServiceUrl; -var gCachedMethods; - -Ajax.Responders.register({ - -onException: function(req, err) { - try { - document.pwgError = err; - dumpError(err); - } - catch (e) - { - alert (err); - alert (err.message); - } -}, - -onComplete: function(req, transport) { - if (!req.responseIsSuccess()) - { - var s = 'Completion failure\n' + transport.status + ' ' + transport.statusText; - if (transport.status>=300) - { - s += '\n'; - s += transport.responseText.substr(0,1000); - } - dumpError(s); - } - } +

+ This page lists all API methods available on your Piwigo installation, part of the Piwigo core or added by third-party plugins. + For each method you can consult required and optional parameters, and even test them in direct live! +

+ +

+ For more information you can consult our Wiki Piwigo Web API and our forums. +

+
+ + + + + + + +
+ +
+ + + + + - - - - - - - - -
- - Go! -
- -
-
- -
- -

Methods

- -
- -
-

-
- - - - - - - - - - -
-
- - - - - - - - - - -
Request format: - -
Response format: - -
-

- Invoke - Invoke (new Window) -

- 		- - - - - - - - - - - -
ParameterExtraSendValue
-
- -
- -
- -
-
- - -
-
- -
- - + \ No newline at end of file -- cgit v1.2.3