README

Dokumentácia

swiftyper-php API dokumentácia pre PHP.

Požiadavky

PHP 5.6.0+.

Composer

Knižnicu je možné nainštalovať cez Composer. Stačí zadať príkaz:

composer require swiftyper/swiftyper-php

Následne do vašej aplikácie pridajte autoload:

require_once('vendor/autoload.php');

Manuálna inštalácia

Pri manuálnej inštalácii stačí stiahnuť vydanie knižnice. Následne je nutné pridať tento inicializačný súbor:

require_once('/path/to/swiftyper-php/init.php');

Použitie

Pred začatím používania je nutné nastaviť API kľúč ktorý môžete spravovať cez Váš používateľský účet.

API kľúče sú predvolene neobmedzené. Neobmedzené kľúče nie sú bezpečné, pretože ich môže používať ktokoľvek a odkiaľkoľvek. Pre produkčné aplikácie odporúčame nastaviť obmedzenia API kľúča nakoľko pomáhajú zabrániť neoprávnenému použitiu a vyčerpávaniu kvót. Obmedzenia určujú, ktoré webové stránky alebo IP adresy môžu používať API kľúč.

\Swiftyper\Swiftyper::setApiKey('VÁŠ_API_KĽÚČ_SLUŽBY_BUSINESS');
$results = \Swiftyper\Business::query([
    'query'   => 'Google Slovakia',
    'country' => 'SK',
]);

var_dump($results->toArray());

Pristupovanie k odpovedi požiadavky

Údaje z API odpovede na ľubovoľnom objekte môžete získať prostredníctvom metódy getLastResponse().

$business = \Swiftyper\Business::detail('sk_WbilvhDEDokFTWk0FbNjeQ');
var_dump($business->getLastResponse());

Konfigurácia automatického znovupripojenia

Knižnici je možné nakonfigurovať počet opakovaní v prípade zlyhania požiadavky.

\Swiftyper\Swiftyper::setMaxNetworkRetries(2);

swiftyper / swiftyper-php

Maintainers

Details