CWIS Developer Documentation
|
Public Member Functions | |
__construct ($APIUrl, $APIPassword, $CheckForDuplicateFn, $RegisterMessageFn) | |
Constructor. More... | |
DoRestCommand ($Params) | |
Run a REST API command against a remote site. More... | |
EncodeEncryptedMessage ($Data) | |
Construct an encrypted message packet from provided data. More... | |
DecodeEncryptedMessage ($PostData) | |
Decrypt an encrypted message packet. More... | |
Definition at line 10 of file RestAPIHelper.php.
RestAPIHelper::__construct | ( | $APIUrl, | |
$APIPassword, | |||
$CheckForDuplicateFn, | |||
$RegisterMessageFn | |||
) |
Constructor.
string | $APIUrl | Url to which REST calls will be directed. |
string | $APIPassword | Password for encrypting and authenticating rest calls. |
callable | $CheckForDuplicateFn | Function to check for duplicated messages. |
callable | $RegisterMessageFn | Function to register a message as received. |
Definition at line 22 of file RestAPIHelper.php.
RestAPIHelper::DecodeEncryptedMessage | ( | $PostData | ) |
Decrypt an encrypted message packet.
array | $PostData | Encrypted data. |
Definition at line 146 of file RestAPIHelper.php.
Referenced by DoRestCommand().
RestAPIHelper::DoRestCommand | ( | $Params | ) |
Run a REST API command against a remote site.
array | $Params | REST API call parameters (often from $_POST). |
Definition at line 37 of file RestAPIHelper.php.
References DecodeEncryptedMessage(), and EncodeEncryptedMessage().
RestAPIHelper::EncodeEncryptedMessage | ( | $Data | ) |
Construct an encrypted message packet from provided data.
array | $Data | Data to encapsulate |
Definition at line 91 of file RestAPIHelper.php.
Referenced by DoRestCommand().