README

Production environment is located at https://api.moje.uctoplus.sk/production/.

Sandbox environment is located at https://api.moje.uctoplus.sk/sandbox/.

All communication with API is encoded in UTF-8. This REST API is based on Open API v3 standard. For help with implementation or access to the test environment please contact our helpdesk

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/uctoplus/uctoplus-php-api.git"
    }
  ],
  "require": {
    "uctoplus/uctoplus-php-api": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/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: api-key
$config = Uctoplus\API\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Uctoplus\API\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');


$apiInstance = new Uctoplus\API\Api\AddressListApi(
    // 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
);
$address = new \Uctoplus\API\Models\Address(); // \Uctoplus\API\Models\Address | Address
$except = array(new \Uctoplus\API\Models\\Uctoplus\API\Models\Except()); // \Uctoplus\API\Models\Except[] | Optional arguments for exclude data from response

try {
    $result = $apiInstance->addAddress($address, $except);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AddressListApi->addAddress: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.moje.uctoplus.sk/production

Class	Method	HTTP request	Description
AddressListApi	addAddress	POST /v2/address-list/add	addAddress
AddressListApi	getAddressById	GET /v2/address-list/{id}/get	getAddressById.
AddressListApi	getAddressByInternalId	GET /v2/address-list/{id}/get-by-internal-id	getAddressByInternalId.
AddressListApi	getAddressList	GET /v2/address-list	getAddressList
CodeListsApi	getCountries	GET /v2/dial/global/countries	getCountries
CodeListsApi	getCurrencies	GET /v2/dial/global/currencies	getCurrencies
CodeListsApi	getDeliveryTypes	GET /v2/dial/delivery-types	getDeliveryTypes
CodeListsApi	getInvoiceCounter	GET /v2/dial/invoice-counters/{counter}	getInvoiceCounter
CodeListsApi	getInvoiceCounters	GET /v2/dial/invoice-type/{invoiceType}/counters	getInvoiceCounters
CodeListsApi	getLogos	GET /v2/dial/logos	getLogos
CodeListsApi	getPaymentTypes	GET /v2/dial/payment-types	getPaymentTypes
CodeListsApi	getSignatures	GET /v2/dial/signatures	getSignatures
CodeListsApi	getTemplates	GET /v2/dial/invoice/templates	getTemplates
CountriesApi	getCountries	GET /v2/dial/global/countries	getCountries
CurrenciesApi	getCurrencies	GET /v2/dial/global/currencies	getCurrencies
DeliveryTypesApi	getDeliveryTypes	GET /v2/dial/delivery-types	getDeliveryTypes
InvoiceApi	addInvoice	POST /v3/invoice/add	addInvoice
InvoiceApi	addPaymentToInvoice	POST /v3/invoice/{id}/pay	addPaymentToInvoice
InvoiceApi	getInvoice	GET /v3/invoice/{id}/get	getInvoice
InvoiceApi	sendInvoice	POST /v3/invoice/{id}/send	sendInvoice
InvoiceCountersApi	getInvoiceCounters	GET /v2/dial/invoice-type/{invoiceType}/counters	getInvoiceCounters
InvoiceTemplatesApi	getTemplates	GET /v2/dial/invoice/templates	getTemplates
LogosApi	getLogos	GET /v2/dial/logos	getLogos
PaymentTypesApi	getPaymentTypes	GET /v2/dial/payment-types	getPaymentTypes
SignaturesApi	getSignatures	GET /v2/dial/signatures	getSignatures
UploadApi	uploadFile	POST /v3/upload/add	Uploading files over RestAPI
UploadApi	uploadedFilesIndex	GET /v3/upload/index	uploadFile

Models

Authorization

Authentication schemes defined for the API:

api-key

Type: API key
API key parameter name: api-key
Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

helpdesk@uctoplus.sk

About this package

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

API version: 3.2.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

uctoplus / uctoplus-php-api

Maintainers

Details