PHP encryption and signature example

Dependencies

Uses the PHP standard library (OpenSSL) with no additional dependencies required.
Requires PHP >= 7.1 (supports GCM mode).

Full Code

Usage Instructions

Generate Signature: Use the static generateSignature() method and pass in the HTTP method, request path, timestamp, nonce, and the original JSON body.

Encrypt Request Body: Use the static encryptBody() method and pass in the original JSON, App ID, and apiDataKey.

Sort Query String: Use the static sortQueryString() method to sort query parameters.

Generate Nonce: Use the static generateNonce() method to generate a random string.

Notes

The body used in the signature must always be the original JSON string before encryption (even when X-Enc = aes-gcm-v1 is enabled).

apiDataKey must be a Base64-encoded 32-byte key.

The timestamp must use a Unix timestamp in milliseconds (13 digits).

Content-Type: use application/octet-stream for encrypted payloads and application/json for plaintext payloads.

In GCM mode, PHP’s openssl_encrypt() fills the $tag parameter with a 16-byte authentication tag (authTag).

The AAD (Additional Authenticated Data) parameter in GCM mode is only supported in PHP 7.1+.

PHP Version Requirements

PHP >= 7.1 (supports the AAD parameter in GCM mode)

PHP encryption and signature example

Dependencies#

Full Code#

Usage Instructions#

Notes#

PHP Version Requirements#

Dependencies

Full Code

Usage Instructions

Notes

PHP Version Requirements