Documentation

ApiClient extends Client
in package

Description of ApiClient.

Tags
author

vitex

Table of Contents

Properties

$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.

Methods

__construct()  : mixed
{@inheritDoc}
checkCertificate()  : bool
checkCertificatePassword()  : bool
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 = ''

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 = ''

Methods

__construct()

{@inheritDoc}

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

$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

Parameters
$config : array<string|int, mixed> = []
Tags
throws
Exception

CERT_FILE is not set

throws
Exception

CERT_PASS is not set

checkCertificate()

public static checkCertificate(mixed $certFile, mixed $password) : bool
Parameters
$certFile : mixed
$password : mixed
Return values
bool

checkCertificatePassword()

public static checkCertificatePassword(string $certFile, string $password) : bool
Parameters
$certFile : string
$password : string
Return values
bool

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

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

since version 0.1 - Do not use in production Environment!

Return values
string

sourceString()

Source Identifier.

public static sourceString() : string

since version 0.1 - Do not use in production Environment!

Return values
string

        
On this page

Search results