Author image Sergey Leschenko
and 1 contributors

NAME

WebService::Megaplan - The API for Megaplan.ru service (Web-based business automatization service)

VERSION

Version 0.03

SYNOPSIS

Module allows to call Megaplan API using Perl

See API details on http://wiki.megaplan.ru/API (Russian only)

Currently implemented only low-level API where you have to provide URI of API calls.

    use WebService::Megaplan;

    my $api = WebService::Megaplan->new(
                    login    => 'robot_user',
                    password => 'xxxxxx',
                    hostname => 'mycompany.megaplan.ru',
                    use_ssl  => 1,
                );
    my $employee_id = $api->authorize();

    # get list of tasks
    my $data = $api->get_data('/BumsTaskApiV01/Task/list.api', { OnlyActual => 'true' });
    my $task_list = $data->{data}->{tasks};

    # create new task
    my $task_reply = $api->post_data('/BumsTaskApiV01/Task/create.api', {
                                'Model[Name]'        => 'Test title',
                                'Model[SuperTask]'   => 'p1000001',
                                'Model[Statement]'   => 'Task long description',
                                'Model[Responsible]' => $employee_id, # number like 1000020
                            });
    printf "Created task #%d\n", $task_reply->{data}->{task}->{Id};

METHODS

new(%opt)

Create new API object, providing a hash of options:

login -- login
password -- password
hostname -- hostname of installed Megaplan, usually something like 'somename.megaplan.ru'
port -- port to use to connect Megaplan, not required if default (80 http, 443 https)

authorize

Authenticate itself on Megaplan server and obtain AccessId and SecretKey values.

Returns true value on success (ID of logged in Employee). This method have to be called before any other API calls.

get_data(uri_path, params)

Low-level method to perform GET query to corresponding API method

uri_path -- URI, for example '/BumsTaskApiV01/Task/list.api'
params -- hash-reference of API call arguments (optional)

Returns perl data, converted from resulted JSON. died in case of errors.

post_data(uri_path, params)

Low-level method to perform POST request to API - to create new objects or update existing ones

uri_path -- URI, for example '/BumsCommonApiV01/Comment/create.api'
params -- hash-reference of API call arguments

Returns perl data, converted from resulted JSON. died in case of errors.

AUTHOR

Sergey Leschenko, <sergle.ua at gmail.com>

BUGS

Please report any bugs or feature requests to bug-webservice-megaplan at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WebService-Megaplan. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc WebService::Megaplan

You can also look for information at:

ACKNOWLEDGEMENTS

LICENSE AND COPYRIGHT

Copyright 2013 Sergey Leschenko.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.