<% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>

FS::part_export::ispconfig3

NAME

FS::part_export::ispconfig3

SYNOPSIS

ISPConfig 3 integration for Freeside

DESCRIPTION

This export offers basic svc_acct provisioning for ISPConfig 3. All email accounts will be assigned to a single specified client.

This module also provides generic methods for working through the "ISPConfig3 API".

ISPConfig3 API

These methods allow access to the ISPConfig3 API using the credentials set in the export options.

api_call

Accepts $method and @params. Places an api call to the specified method with the specified params. Returns the result of that call (empty on failure.) Retrieve error messages using "api_error".

Do not include session id in list of params; it will be included automatically. Must run "api_login" first.

api_error

Returns the error string set by "ISPConfig3 API" methods, or a blank string if most recent call produced no errors.

api_error_logout

Attempts "api_logout", but returns "api_error" message from before logout was attempted. Useful for logging out properly after an error.

api_login

Initializes an api session using the credentials for this export. Returns true on success, false on failure. Retrieve error messages using "api_error".

api_logout

Ends the current api session established by "api_login". Returns true on success, false on failure.

SEE ALSO

FS::part_export

AUTHOR

Jonathan Prykop jonathan@freeside.biz

<% include ('/elements/footer.html' ) %>