BackendRequester | PrivMX Docs

‘BackendRequester’ provides functions to call PrivMX Bridge API.

Static Methods

backendRequest(serverUrl:accessToken:method:paramsAsJson:)

Makes a direct request to PrivMX Bridge.

Params

serverUrl

std.string

PrivMX Bridge server URL

accessToken

std.string

token for authorization (see PrivMX Bridge API for more details)

method

std.string

API method to call

paramsAsJson

std.string

API method’s parameters in JSON format

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

Returns

std.string · JSON string representing raw server response

backendRequest(serverUrl:memberToken:method:paramsAsJson:)

Params

serverUrl

std.string

memberToken

std.string

method

std.string

paramsAsJson

std.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:)

Sends request to PrivMX Bridge API.

Params

serverUrl

std.string

PrivMX Bridge server URL

method

std.string

API method to call

paramsAsJson

std.string

API method’s parameters in JSON format

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

Returns

std.string · JSON string representing raw server response

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.