README

Dokumentace

Dokumentace API je publikována na Apiary: https://simpleshopcz.docs.apiary.io/

Instalace

S přiklady

Pro stažení celého repozitáře proveďte příkaz:

git clone https://github.com/redbitcz/simpleshop-api-php-sdk.git

Případně můžete stáhnout celá ZIP archív přes Code > Download ZIP vpravo nahoře. V tomto případě bude třeba kód z archivu rozbalit.

Po stažení je nutné dotáhnout navazující balíčky nutné pro běh:

composer install

V souboru examples/config.php doplňte přihlašovací údaje.

Ve složce examples/ naleznete nejrůznější příklady, které můžete hned vyzkoušet.

Od verze 5.4 PHP má vlastní vestavěný web-server, takže můžete použit ho. Ve složce examples/ spusťte příkaz:

php -S localhost:8000

(pokud bude port obsazen, zkuste jakýkoliv jiný, například: 8001, 8002, 8080, ...) V prohlížeči navštivte stránku http://localhost:8000.

Samotná knihovna

Nainstalujte knihovnu pomocí Composeru (doporučujeme):

composer require redbitcz/simpleshop-api-php-sdk

a následně na začátek vašeho projektu (nejčastěji index.php) přidejte kód pro načtení závislostí:

require __DIR__ . '/vendor/autoload.php';

Důležité: Pokud ve svém projektu již používáte Vyfakturuj, nebo SimpleShop(např. WordPress plugin), ujistěte se, že nemáte knihovnu v projektu vícekrát.

Ve své aplikaci pak jednoduše vytvoříte objekt SimpleShopApi:

$simpleshop = new \Redbitcz\SimpleShop\Api\SimpleShopApi('login', 'API klíč');

Váš login a API klíč najdete v nastavení API v SimpleShop aplikaci.

Nad tímto objektem pak můžete přímo volat metody:

$invoice = $simpleshop->getInvoice(12345);

Požadavky

Knihovna pro správné fungování potřebuje:

PHP verze 7.3 a vyšší
Composer (instalace ve Windows a v Linux/Unix/macOS)
Rozšíření cURL
Rozšíření JSON

Příklady použití

Příklady použití knihovny jsou popsány ve složce examples.

Changelog

Přehled verzí a změn: https://github.com/redbitcz/simpleshop-api-php-sdk/releases

redbitcz / simpleshop-api-php-sdk

Maintainers

Details