ePages 7.28.0 - DE_EPAGES/Shippo/API/User.pm

Package DE_EPAGES::Shippo::API::User

Some functions to handle User management to Shippo.

@EXPORT_OK
CreateShippoUser
GetShippoAuthToken
ExistsShippoUser
DeleteShippoUser

Functions

CreateShippoUser
DeleteShippoUser
ExistsShippoUser
GetShippoAuthToken

CreateShippoUser

creates Shippo user

Syntax
$User = CreateShippoUser( $Shop, $PlaintextPassword );
Input
$Shop (object)
shop
$PlaintextPassword (string)
plaintext password
Return
$User (object)
new user

DeleteShippoUser

deletes Shippo user

Syntax
DeleteShippoUser( $Shop );
Input
$Shop (object)
shop

ExistsShippoUser

check if Shippo user exists

Syntax
$IsShippoUser = ExistsShippoUser( $Shop );
Input
$Shop (object)
shop
Return
$IsShippoUser (boolean)
true if user exists

GetShippoAuthToken

Creates an AuthToken for the given credentials.

Syntax
$AuthToken = GetShippoAuthToken($User, $Password, $SoapUrl);
Example
$AuthToken = GetShippoAuthToken($Servlet->user->pathString, $Password, $SoapUrl);
Input
$User (string)
user object path
$Password (string)
plaintext password
$SoapUrl (string)
soapUrl
Return
$AuthToken (string)
the auth token