privmx::endpoint::core::BackendRequester Class Reference

#include <privmx/endpoint/core/BackendRequester.hpp>

Static Public Member Functions
static std::string	backendRequest (const std::string &serverUrl, const std::string &accessToken, const std::string &method, const std::string &paramsAsJson)
static std::string	backendRequest (const std::string &serverUrl, const std::string &method, const std::string &paramsAsJson)
static std::string	backendRequest (const std::string &serverUrl, const std::string &apiKeyId, const std::string &apiKeySecret, const int64_t mode, const std::string &method, const std::string &paramsAsJson)

Detailed Description

'BackendRequester' provides functions to call PrivMX Bridge API.

Member Function Documentation

backendRequest() [1/3]

std::string privmx::endpoint::core::BackendRequester::backendRequest ( const std::string & serverUrl, const std::string & accessToken, const std::string & method, const std::string & paramsAsJson )

static

Sends a request to PrivMX Bridge API using access token for authorization.

Parameters

serverUrl	PrivMX Bridge server URL
accessToken	token for authorization (see PrivMX Bridge API for more details)
method	API method to call
paramsAsJson	API method's parameters in JSON format

Returns

JSON string representing raw server response

backendRequest() [2/3]

std::string privmx::endpoint::core::BackendRequester::backendRequest ( const std::string & serverUrl, const std::string & apiKeyId, const std::string & apiKeySecret, const int64_t mode, const std::string & method, const std::string & paramsAsJson )

static

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

Parameters

serverUrl	PrivMX Bridge server URL
apiKeyId	API KEY ID (see PrivMX Bridge API for more details)
apiKeySecret	API KEY SECRET (see PrivMX Bridge API for more details)
mode	allows you to set whether the request should be signed (mode = 1) or plain (mode = 0)
method	API method to call
paramsAsJson	API method's parameters in JSON format

Returns

JSON string representing raw server response

backendRequest() [3/3]

std::string privmx::endpoint::core::BackendRequester::backendRequest ( const std::string & serverUrl, const std::string & method, const std::string & paramsAsJson )

static

Sends request to PrivMX Bridge API.

Parameters

serverUrl	PrivMX Bridge server URL
method	API method to call
paramsAsJson	API method's parameters in JSON format

Returns

JSON string representing raw server response

---

The documentation for this class was generated from the following file:

• privmx/endpoint/core/BackendRequester.hpp