multidialogo/api-php-sdk

There is no license information available for the latest version (v0.12.4) of this package.

php client for multidialogo services

v0.12.4 2023-11-03 11:39 UTC

Requires

• php: >=7.4
• ext-json: *
• guzzlehttp/guzzle: ^7.0

Requires (Dev)

• phpunit/phpunit: *

Unknown License

• php
• sdk
• multidialogo-api

README

A set of classes to manage the interaction with Multidialogo API.

Quick Start

Installation

composer require multidialogo/api-php-sdk

Use example

    use multidialogo\client\MultidialogoClient;
    
    $client = MultidialogoClient::builder()
        ->withHostUrl('http://rest.multidialogo.local')
        ->withPasswordCredentials('username', 'password')
        ->withLanguage('it')
        ->build();
    
    $response = $client->getJson('users/me', ['include' => 'profile']);
    
    print_r($response->body);

It is possible to configure the client with a filesystem-based credentials store.

This is achieved with this helper:

        ->withFileTokenStorage(CLIENT_PROVIDED_FILESYSTEM_PATH) 

So the full example would be:

        $client = MultidialogoClient::builder()
            ->withHostUrl('https://rest-stage.multidialogo.it')
            ->withFileTokenStorage(CLIENT_PROVIDED_FILESYSTEM_PATH)
            ->withLanguage('it')
            ->build();

        $client->getJson('geo/countries');

CLIENT_PROVIDED_FILESYSTEM_PATH is a string specifying a folder, that will be used by the client to store the credentials. The folder must be writable. It is totally optional, and it allows to omit user password until it is mandatory (ie until the main or refresh token expires).

It is possibile to pass a token directly to the client. This use case is suitable for situation where the login is managed by a frontend, that is handling the token refresh procedure and passing the token to a backend proxy. This is done via the withBearerToken helper method. Example:

        $client = MultidialogoClient::builder()
            ->withHostUrl('https://rest-stage.multidialogo.it')
            ->withBearerToken($token)
            ->withLanguage('it')
            ->build();

        $client->getJson('geo/countries');

How to run unit tests in a docker environment

Install dependencies including dev ones:

docker compose run --rm multidialogo-api-php-sdk-composer composer install

Run phpunit test suite:

docker compose run --rm multidialogo-api-php-sdk-composer vendor/bin/phpunit .