Documentation

ApiClient extends Client
in package

Description of ApiClient

Tags
author

vitex

Table of Contents

$mockMode  : bool
Use mocking for api calls ?
$pSUIPAddress  : string
the end IP address of the client application (no server) in IPv4 or IPv6 format. If the bank client (your user) uses a browser by which he accesses your server app, we need to know the IP address of his browser.
$xIBMClientId  : string
ClientID obtained from Developer Portal - when you registered your app with us.
__construct()  : mixed
checkCertificatePresence()  : bool
Try to check certificate readibilty
getMockMode()  : bool
Use mocking uri for api calls ?
getpSUIPAddress()  : string
Keep user public IP here
getPublicIP()  : string
Obtain Your current Public IP
getXIBMClientId()  : string
ClientID obtained from Developer Portal
getxRequestId()  : string
Request Identifier
sourceString()  : string
Source Identifier

Properties

$mockMode

Use mocking for api calls ?

protected bool $mockMode = false

$pSUIPAddress

the end IP address of the client application (no server) in IPv4 or IPv6 format. If the bank client (your user) uses a browser by which he accesses your server app, we need to know the IP address of his browser.

protected string $pSUIPAddress = null

Always provide the closest IP address to the real end-user possible. (optional)

$xIBMClientId

ClientID obtained from Developer Portal - when you registered your app with us.

protected string $xIBMClientId = null

Methods

__construct()

public __construct([array<string|int, mixed> $config = [] ]) : mixed
Parameters
$config : array<string|int, mixed> = []
Tags
inheritDoc

$config['clientid'] - obtained from Developer Portal - when you registered your app with us. $config['cert'] = ['/path/to/cert.p12','certificat password'] $config['clientpubip'] = the closest IP address to the real end-user $config['mocking'] = true to use /rbcz/premium/mock/* endpoints

throws
Exception

CERT_FILE is not set

throws
Exception

CERT_PASS is not set

Return values
mixed

checkCertificatePresence()

Try to check certificate readibilty

public static checkCertificatePresence(string $certFile[, bool $die = false ]) : bool
Parameters
$certFile : string

path to certificate

$die : bool = false

throw exception or return false ?

Tags
throws
Exception
  • Certificate file not found
Return values
bool

certificate file

getMockMode()

Use mocking uri for api calls ?

public getMockMode() : bool
Return values
bool

getpSUIPAddress()

Keep user public IP here

public getpSUIPAddress() : string
Return values
string

getPublicIP()

Obtain Your current Public IP

public static getPublicIP() : string
Tags
deprecated

since version 0.1 - Do not use in production Environment!

Return values
string

getXIBMClientId()

ClientID obtained from Developer Portal

public getXIBMClientId() : string
Return values
string

getxRequestId()

Request Identifier

public static getxRequestId() : string
Tags
deprecated

since version 0.1 - Do not use in production Environment!

Return values
string

sourceString()

Source Identifier

public static sourceString() : string
Tags
deprecated

since version 0.1 - Do not use in production Environment!

Return values
string

Search results