Skip to content

Spoje-NET/php-csas-accountsapi

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Premium - Accounts API

API for managing production accounts.

For more information, please visit https://www.csas.cz/content/dam/cz/csas/www_csas_cz/dokumenty/obecne/how-to-connect-to-api-of-cs.pdf.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{ "repositories": [ { "type": "vcs", "url": "https://github.com/Spoje-NET/php-csas-webapi.git" } ], "require": { "Spoje-NET/php-csas-webapi": "*@dev" } }

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php require_once('/path/to/Premium - Accounts API/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: ApiKeyAuth $config = SpojeNet\CSas\Configuration::getDefaultConfiguration()->setApiKey('WEB-API-key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = SpojeNet\CSas\Configuration::getDefaultConfiguration()->setApiKeyPrefix('WEB-API-key', 'Bearer'); // Configure Bearer (JWT) authorization: bearerAuth $config = SpojeNet\CSas\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); $apiInstance = new SpojeNet\CSas\Api\DefaultApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $id = D2C8C1DCC51A3738538A40A4863CA288E0225E52; // string | Unique system identification of the client account $accountStatementId = 002498aa881201c7; // string | Unique identifier of the account statement $format = pdf; // string | Selected statement format try { $result = $apiInstance->downloadAccountStatement($id, $accountStatementId, $format); print_r($result); } catch (Exception $e) { echo 'Exception when calling DefaultApi->downloadAccountStatement: ', $e->getMessage(), PHP_EOL; }

API Endpoints

All URIs are relative to https://www.csas.cz/webapi/api/v3/accounts

Class Method HTTP request Description
DefaultApi downloadAccountStatement GET /my/accounts/{id}/statements/{accountStatementId}/download Download account statement
DefaultApi getAccountBalance GET /my/accounts/{id}/balance Get account balance
DefaultApi getAccountStatements GET /my/accounts/{id}/statements Get account statements
DefaultApi getAccounts GET /my/accounts Get account details
DefaultApi getTransactions GET /my/accounts/{id}/transactions Overview of transactions

Models

Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication (JWT)

ApiKeyAuth

  • Type: API key
  • API key parameter name: WEB-API-key
  • Location: HTTP header

Tests

To run the tests, use:

composer install vendor/bin/phpunit

Author

vitezslav.dvorak@spojenet.cz

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
    • Generator version: 7.10.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

About

PHP Client library for www.csas.cz/webapi/api/v3/

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages