Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/regru/api-parallelswpb

API-ParallelsWPB
https://github.com/regru/api-parallelswpb

Last synced: 29 days ago
JSON representation

API-ParallelsWPB

Awesome Lists containing this project

README

        

# NAME

API::ParallelsWPB - client for Parallels Presence Builder API

# SYNOPSIS

```perl
my $client = API::ParallelsWPB->new(username => 'admin', password => 'passw0rd', server => 'builder.server.mysite.ru');
my $response = $client->get_sites_info;
if ($response->success) {
for my $site (@{$response->response}) {
say "UUID: ". $site->{ uuid };
}
}
else {
warn "Error occured: " . $response->error . ", Status: " . $response->status;
}
```
# METHODS

## new

Creates new client instance. Parameters for ```new``` are:

- username

Username for connection to Parallels WebPresence Builder instance. Required parameter.

- password

Password for connection to Parallels WebPresence Builder instance. Required parameter.

- server

Servername or server ip address for connection to Parallels WebPresence Builder instance. Optional parameter.

- api_version

API version, used in API url constructing. Optional parameter.

- debug

Debug flag, requests will be loogged to stderr. Optional parameter.

- timeout

Connection timeout. Optional parameter.

# SEE ALSO

[Parallels Presence Builder Guide](http://download1.parallels.com/WPB/Doc/11.5/en-US/online/presence-builder-standalone-installation-administration-guide)

# AUTHORS

- Alexander Ruzhnikov, ""

- Polina Shubina, ""

# LICENSE AND COPYRIGHT

This software is copyright (c) 2013 by REG.RU LLC.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.