BackendRequester | PrivMX Docs

Tool for direct requests to PrivMX Bridge.

Static Methods

backendRequest(serverUrl:memberToken:method:paramsAsJson:)

Makes a direct request to PrivMX Bridge. This function allows you to make direct API requests to PrivMX Bridge with the required authorization and parameters. The response is returned as a string, representing the result of the request.

Params

serverUrl

std.string

The URL of PrivMX cloud server to which the request will be sent.

memberToken

std.string

The authorization token for the member making the request.

method

std.string

The API method or endpoint to be called on PrivMX Bridge.

paramsAsJson

std.string

The parameters for the request, formatted as a JSON string.

public static func backendRequest(
serverUrl: std.string,
memberToken: std.string,
method: std.string,
paramsAsJson: std.string
) throws -> std.string

Returns

std.string ·

backendRequest(serverUrl:method:paramsAsJson:)

Makes a direct request to PrivMX Bridge. This function allows you to make direct API requests to PrivMX Bridge with the required parameters. The response is returned as a string, representing the result of the request.

Params

serverUrl

std.string

The URL of PrivMX cloud server to which the request will be sent.

method

std.string

The API method or endpoint to be called on PrivMX Bridge.

paramsAsJson

std.string

The parameters for the request, formatted as a JSON string.

public static func backendRequest(
serverUrl: std.string,
method: std.string,
paramsAsJson: std.string
) throws -> std.string

Returns

std.string ·

backendRequest(serverUrl:apiKeyId:apiKeySecret:mode:method:paramsAsJson:)

Sends a request to PrivMX Bridge API using pair of API KEY ID and API KEY SECRET for authorization.

Params

serverUrl

std.string

PrivMX Bridge server URL

apiKeyId

std.string

API KEY ID (see PrivMX Bridge API for more details)

apiKeySecret

std.string

API KEY SECRET (see PrivMX Bridge API for more details)

mode

Int64

allows you to set whether the request should be signed (mode = 1) or plain (mode = 0)

method

std.string

API method to call

paramsAsJson

std.string

API method’s parameters in JSON format

public static func backendRequest(
serverUrl: std.string,
apiKeyId: std.string,
apiKeySecret: std.string,
mode: Int64,
method: std.string,
paramsAsJson: std.string
) throws -> std.string

Returns

std.string · A string containing the response from PrivMX Bridge, typically in JSON format.