view release on metacpan or  search on metacpan

lib/Confluence/Client/XMLRPC.pm  view on Meta::CPAN

However, due to backwards compatibility reasons the default value for the 
API version in this module still is B<1>. 

Note: you can use B<most but not all> of the version 1 API calls on newer 
Confluence installations! The Confluence docs contain a detailed and 
authoritative description of the
L<differences between versions 1 and 2|https://developer.atlassian.com/display/CONFDEV/Confluence+XML-RPC+and+SOAP+APIs#ConfluenceXML-RPCandSOAPAPIs-v2apiRemoteAPIversion1andversion2>
of the API!

The new version 2 API implements the same methods as the version 1 API, 
however all content is stored and retrieved using the storage format. 
This means that you cannot, for example, create a page using wiki markup 
with the version 2 API, you must instead define the page using the new
XHTML based storage format.
You will be able to create pages, blogs and comments in wiki markup 
using the version 1 API even on Confluence 4.0 and later. However you 
will no longer be able to retrieve pages, blogs and comments using 
the version 1 API.

To aid in the migration phase Confluence 4.0 and up provide a method
C<convertWikiToStorageFormat()> where you can pass in a string with 
wiki markup and will recieve the same data converted to the new storage 
format (which you can then use to create or update a page).

=head1 EXAMPLES

=over 4

=item C<upload_files.pl> - Upload files

The sample script uploads the contents of a directory to the wiki. Each file 
in the directory is uploaded as a separate page. The page title is the file 
name with extension removed. This script requires five arguments: API url, 
user name, password, space key and a directory name.

=item C<upload_users.pl> - Upload Users

This script reads and loads a list of users from a file (or stdin). If errors 
are encountered then the script will print an error message, but continue 
processing.
This script requires three arguments: API url, name and password of an admin 
user.

=item C<det_group_mbrship.pl> - Determine Group Membership

The script prints the group membership of all users.
This script requires three arguments: API url, name and password of an admin 
user.

=back

Please refer to the C<examples> directory of the distribution for the scripts 
themselves.

=head1 NOTES

The package uses the L<RPC::XML> module to do the heavy lifting. Read the 
perldoc for this package to learn more.

L<RPC::XML> uses LWP for handling C<http>/C<https> messaging. If you are 
experiencing problems when connecting to a C<https> based API endpoint,
please make sure that the necessary modules - like, e.g. 
L<LWP::Protocol::https> - are installed.

For further information on the Confluence API itself please refer to the 
L<official documentation|https://developer.atlassian.com/display/CONFDEV/Confluence+XML-RPC+and+SOAP+APIs>
as provided by Atlassian.

Please note that starting with Confluence 5.5 the XML-RPC API will be 
deprecated, meaning that Atlassian will not add new features or fix bugs 
related to the XML-RPC API for Confluence 5.5 or later.
This does B<not> mean, that this module will not work with newer Confluence
versions: as of now, there is no information if or when Atlassian will remove
the XML-RPC API and rely solely on the new REST API.

=head1 CAVEAT

B<ATTENTION>, please: This module was written by Asgeir Nilsen in 2004 and 
later on improved by Giles Lewis, Martin Ellis, and Torben K. Jensen.

I - Heiko Jansen - only took the available source code and created a CPAN 
distribution for it, because at least to me a Perl module almost does not 
exist if it's not on available via CPAN.

This package B<should> work with any remote API function.

The original authors tested it with C<addUserToGroup>, C<getActiveUsers>, 
C<getPage>, C<getPages>, C<getServerInfo>, C<getUser>, and C<storePage>. 
I (Heiko Jansen) have used it successfully to create and update pages, but 
I did B<not> test most other API functions and am thus B<unable to give any 
guarantee that it will work as expected>!

The original module was simply named "Confluence" but since Atlassian is 
currently working on a new REST-based API I renamed it to 
C<Confluence::Client::XMLRPC>.

=head1 AUTHORS

=over 4

=item *

Asgeir Nilsen

=item *

Giles Lewis

=item *

Martin Ellis

=item *

Torben K. Jensen

=item *

Heiko Jansen <hjansen@cpan.org>

=back