https://github.com/spoje-net/ipex-b2b
PHP Library for interaction with restapi.ipex.cz
https://github.com/spoje-net/ipex-b2b
debian easephp ipex php-library rest-client voip-billing voip-from-php
Last synced: 2 months ago
JSON representation
PHP Library for interaction with restapi.ipex.cz
- Host: GitHub
- URL: https://github.com/spoje-net/ipex-b2b
- Owner: Spoje-NET
- License: apache-2.0
- Created: 2017-09-20T23:26:51.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2025-01-13T18:39:41.000Z (5 months ago)
- Last Synced: 2025-02-12T23:29:30.694Z (4 months ago)
- Topics: debian, easephp, ipex, php-library, rest-client, voip-billing, voip-from-php
- Language: PHP
- Homepage: https://restapi.ipex.cz/documentation
- Size: 153 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ipex-b2b
CZ: PHP Knihovna pro snadnou práci s Rest API [IPEX B2B](https://restapi.ipex.cz/documentation)
[](https://github.com/Spoje-NET/ipex-b2b)
[](https://github.com/Spoje-NET/ipex-b2b/releases)
[](https://github.com/Spoje-NET/ipex-b2b/blob/master/LICENSE)
[](https://packagist.org/packages/spoje.net/ipex-b2b)
[](https://packagist.org/packages/spoje.net/ipex-b2b)
# Poděkování
Vznik této knihovny by nebyl možný bez laskavé podpory společnosti [Spoje.Net](http://www.spoje.net),
která hradila vývoj řešení pro navýšení kreditu na VoIP služby. :+1:
U společnosti Spoje.Net, je možné si objednat komerční podporu pro integraci
knihovny do vašich projektů.
Instalace
---------
composer require spojenet/ipexb2b
Konfigurace
-----------
Konfigurace se provádí nastavením následujících konstant:
```php
/**
* Write logs as:
*/
define('LOG_NAME', 'IPEXB2B_Test');
define('LOG_TYPE', 'syslog');
/*
* URL ipex-b2b API
*/
define('IPEX_URL', 'https://restapi.ipex.cz');
/*
* Uživatel ipex-b2b API
*/
define('IPEX_LOGIN', 'firma_api');
/*
* Heslo ipex-b2b API
*/
define('IPEX_PASSWORD', 'Ceeghul');
```
nebo je možné přihlašovací údaje zadávat při vytváření instance třídy.
```php
$pravnik = new \IPEXB2B\Rights(null,[
'url' => 'https://testapi.ipex.cz',
'user' => 'resttest',
'password' => '-dj3x21xaA_'
]);
```
Tento způsob nastavení má vyšší prioritu než výše uvedené definovaní konstant.
Jak to celé funguje ?
---------------------
Ústřední komponentou celé knihovny je Třída ApiClient, která je schopna pomocí
PHP rozšíření curl komunikovat s REST Api IPEX.
Z ní jsou pak odvozeny třídy pro jednotlivé sekce, obsahující metody pro
často používané operace, například "Navyš kredit" v případě VoIP.
Nová odvozená třída vzniká tak že jméno třídy je název sekce.
Tzn. Pokud chceme odvodit
novou třídu pro sekci "simcards" bude vypadat takto:
```php
requestData() );
```
Docker
------
docker pull vitexsoftware/ipex-b2b
Debian/Ubuntu
-------------
Pro Linux jsou k dispozici .deb balíčky. Prosím použijte repo:
```shell
sudo apt install lsb-release wget apt-transport-https bzip2
sudo wget -O /usr/share/keyrings/vitexsoftware.gpg https://repo.vitexsoftware.cz/keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/vitexsoftware.gpg] https://repo.vitexsoftware.cz $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/vitexsoftware.list
sudo apt update
sudo apt install php-spojenet-ipex-b2b
```
V tomto případě je potřeba do souboru composer.json vaší aplikace přidat:
```json
"require": {
"deb/ipex-b2b": "*",
"deb/ease-core": "*"
},
"repositories": [
{
"type": "path",
"url": "/usr/share/php/IPEXB2B",
"options": {
"symlink": true
}
},
{
"type": "path",
"url": "/usr/share/php/EaseCore",
"options": {
"symlink": true
}
}
]
```
Takže při instalaci závislostí bude vypadat nějak takto:
Loading composer repositories with package information
Installing dependencies from lock file
- Installing deb/ease-framework (1.24)
Symlinked from /usr/share/php/Ease
- Installing deb/ipex-b2b (0.2.1)
Symlinked from /usr/share/php/IPEXB2B
A aktualizaci bude možné dělat globálně pro celý systém prostřednictvím apt-get.