OliveTin::Api::OliveTinClient Class Reference

Public Member Functions
	__construct (private readonly string $baseUrl, private readonly string $apiKey, private readonly string $apiPrefix='/api',)
	init ()
	startAction (string $bindingId, array $arguments=[], ?string $uniqueTrackingId=null)
	startActionAndWait (string $actionId, array $arguments=[])

Detailed Description

Minimal OliveTin Connect-RPC (JSON) client for session bootstrap and starting actions.

Credentials are sent only as {

See also

https://datatracker.ietf.org/doc/html/rfc6750 Bearer} tokens in the Authorization header. OliveTin treats this value as a JWT when JWT authentication is configured; otherwise terminate TLS at a proxy that validates your API key and forwards trusted identity headers OliveTin understands.

Member Function Documentation

init()

OliveTin::Api::OliveTinClient::init

(

)

Call Init (same bootstrap RPC the web UI uses). Useful to verify TLS, bearer auth, and that the OliveTin API path is reachable.

Returns

array<string, mixed> Decoded InitResponse (camelCase JSON keys per Connect)

startAction()

OliveTin::Api::OliveTinClient::startAction	(	string	$bindingId,
		array	$arguments = [],
		?string	$uniqueTrackingId = null )

Start an action using its dashboard binding identifier.

Parameters

array<string,string>

$arguments Argument name => value

Returns

array{executionTrackingId: string}

startActionAndWait()

OliveTin::Api::OliveTinClient::startActionAndWait	(	string	$actionId,
		array	$arguments = [] )

Start an action by configured action id and wait until completion.

Parameters

array<string,string>

$arguments

Returns

array<string, mixed> Decoded LogEntry message (camelCase keys)

---

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

• src/OliveTinClient.php