budgetlens/copernica-rest-api-client

Copernica Rest API client

v3.0.3 2023-12-27 16:37 UTC

Requires

• php: ^8.1
• ext-json: *
• composer/ca-bundle: ^1.3
• guzzlehttp/guzzle: ^7.4
• illuminate/collections: ^9.1|^10.0

Requires (Dev)

• overtrue/phplint: ^4.1
• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: ^3.6

MIT

• Sebastiaan Blaas

• php
• rest
• api
• copernica

README

Copernica API documentation

Requirements

To use the Copernica Rest API client, the following things are required:

• Generate your access_token

Installation

Install package using composer

composer require budgetlens/copernica-rest-api-client

Getting started

$accessToken = 'your-token';
$client = new \Budgetlens\CopernicaRestApi\Client($accessToken);

If required additional configuration can be added by supplying an additional config

class MyConfig implements Budgetlens\CopernicaRestApi\Contracts\Config
{
    public function getEndpoint(): string
    {
        return 'https://api.copernica.com/v3';
    }

    public function getMiddleware(): array
    {
        return $this->middleware;
    }

    public function addMiddleware($middleware)
    {
        $this->middleware[] = $middleware;
    }

    public function getTimeout(): int
    {
        return 180;
    }

    public function getUserAgent(): string
    {
        return '';
    }
}
$client->setConfig($config);

Examples

for examples see "tests folder"