Download the PHP package tomatom/depoto-php-client without Composer
On this page you can find all versions of the php package tomatom/depoto-php-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download tomatom/depoto-php-client
More information about tomatom/depoto-php-client
Files in tomatom/depoto-php-client
Package depoto-php-client
Short Description Depoto API client
License MIT
Homepage https://depoto.cz/
Informations about the package depoto-php-client
Depoto PHP Client
Depoto
Depoto je skladový, expediční a pokladní systém poskytující GraphQl API s OAuth2 authentifikací. Tato knihovna má za cíl práci s API zpříjemnit;)
Instalace
Doporučujeme instalaci pomocí Composer:
Použití
Čtěte best practices ve WIKI !!!:
Pokud se z vaší aplikace potřebujete připojovat k různým účtů, možná vašemu service containeru příjde vhod továrna:
GraphQl
- Query pro čtení a Mutation pro czápis.
- Definuji data (stromovou strukturu), která chci vrátit.
- GraphQL dokumentace
Pro testování queries a procházení kompletního aktuálního schématu použijte GraphQL Explorer / GraphiQL konzoli.
Omezení počtu požadavků (HTTP 429)
Depoto server omezuje zátěž API pro každého uživatele: počet souběžných požadavků a čas, který server zpracováním požadavků stráví.
Požadavek nad limit odmítne odpovědí 429 Too Many Requests s hlavičkou Retry-After – počtem sekund, po kterých má smysl požadavek poslat znovu
(při příliš mnoha souběžných požadavcích 1 s, při vyčerpání časového rozpočtu 2 až 300 s).
Limit se vyhodnocuje hned po ověření uživatele, ještě než server začne GraphQL požadavek zpracovávat. Odmítnutý požadavek, včetně mutace, tedy vůbec neproběhl a je bezpečné ho poslat znovu.
Server zatím limity jen měří a nevynucuje. Vynucování se nezapne dřív, než s odpovědí 429 budou umět pracovat všechny konektory (viz níže).
Co dělá klient
query(),mutation(),batchQuery()abatchMutation()na odpověď 429 od Depoto serveru počkajíRetry-Aftersekund (chybějící, nečitelná nebo nulová hlavička = 1 s) a požadavek pošlou znovu, nejvýše 2× v rámci jednoho volání.- Automaticky se opakuje jen odmítnutí Depoto serverem, tj. odpověď 429 s JSON tělem, v jehož poli
errorsje chyba s"code": "RATE_LIMITED"({"errors":[{"message":"Too many concurrent requests.","code":"RATE_LIMITED"}]}). U jiné odpovědi 429 (např. od proxy nebo load balanceru před serverem, s jiným či neznámým tělem) nelze vyloučit, že požadavek už proběhl. Klient ji proto neopakuje a rovnou vyhodíRateLimitException. - K čekání klient přičte náhodný rozptyl 0 až 1000 ms, aby workery odmítnuté ve stejnou chvíli (např. 10–15 replik jednoho konzumenta pod jedním uživatelem)
neposlaly požadavky znovu všechny ve stejné sekundě. Rozptyl se do limitu
setMaxRateLimitWait()nepočítá, porovnává se jenRetry-After. - Pokud server žádá delší čekání než 5 s (
getMaxRateLimitWait()), klient nečeká a výjimku vyhodí hned – zbytečně by blokoval worker. - Pokud je i poslední odpověď 429, vyhodí
Depoto\Exception\RateLimitException. Je potomkemServerException, takže ji zachytí i stávajícícatch (ServerException $e).getRetryAfter()vrací počet sekund z hlavičkyRetry-After(u data převedený na zbývající sekundy), nebonull, pokud hlavička chybí či je nečitelná. authenticate()(žádost o token) se automaticky neopakuje, na odpověď 429 rovnou vyhodíRateLimitException.- Každé opakování se zaloguje na úrovni
info, konečné odmítnutí na úrovniwarning.
Nastavení (výchozí hodnoty; ClientFactory vytváří klienta s výchozími hodnotami, případně je nastavte na vráceném klientovi):
Nejkratší čekání před opakováním je 1 s, takže setMaxRateLimitWait(0) automatické opakování vypne stejně jako setRateLimitRetries(0).
Jedno volání tak může blokovat až getRateLimitRetries() × (getMaxRateLimitWait() + 1) sekund (výchozí 2 × (5 s + nejvýše 1 s rozptylu) = 12 s), a to u každého volání zvlášť.
V synchronním kontextu (webhook nebo jiný HTTP controller, API proxy), kde volající čeká na odpověď, nastavte
setRateLimitRetries(0) (výjimka hned), nebo setMaxRateLimitWait(1) (klient vyčká jen krátké odmítnutí kvůli souběžným požadavkům),
a při RateLimitException práci odložte do fronty nebo vraťte chybu, místo aby požadavek visel.
Co musí udělat aplikace (konektor)
RateLimitExceptionnikdy nepolykejte. Handler zprávy, který výjimku jen zaloguje (catch (\Exception $e) { $logger->error(...); }), by zprávu zahodil – např. objednávka by se tiše nenaimportovala. Zprávu je nutné zpracovat znovu později, ideálně až zagetRetryAfter()sekund, nejméně však za 1 s –getRetryAfter()může vrátit 0 (hlavičkaRetry-After: 0nebo datum v minulosti) a okamžité opakování by limit jen dál zatěžovalo.null(hlavička chybí) nahraďte výchozí prodlevou.-
Symfony Messenger: výjimku z handleru propusťte ven, nejlépe zabalenou do
RecoverableMessageHandlingExceptions prodlevou podlegetRetryAfter():- Čtvrtý parametr konstruktoru
$retryDelay(v milisekundách) máRecoverableMessageHandlingExceptionod symfony/messenger 7.2 (ověřeno ve verzích 7.3.6 a 8.0.14). Ve verzi 6.4 (ověřeno v 6.4.19) ho konstruktor nemá – tam vyhoďtenew RecoverableMessageHandlingException($e->getMessage(), 0, $e)a prodlevu určíretry_strategytransportu. RecoverableMessageHandlingExceptionvynutí opakování bez ohledu namax_retries– zpráva se zkouší, dokud neprojde.- Pokud výjimku jen propustíte ven (
throw $e;), opakuje se podleretry_strategytransportu. Při nastavenímax_retries: 3, multiplier: 2a výchozí prodlevě 1 s jsou to pokusy po 1, 2 a 4 sekundách, což přiRetry-Afteraž 300 s nemusí stačit a zpráva pak skončí ve failure transportu (nebo se zahodí, pokud žádný není). - Prodlevu (
$retryDelayiretry_strategy) použijí jen transporty, které respektujíDelayStamp(Doctrine, Redis, AMQP). Google Pub/Sub (gps://, petitpress/gps-messenger-bundle) zprávu k opakování znovu neodesílá, jen ji odmítne a Pub/Sub ji doručí znovu podle retry policy subscription – tu nastavte (minimumBackoff/maximumBackoff) tak, aby pokrylaRetry-After.
- Čtvrtý parametr konstruktoru
- Znovu se zpracuje celá zpráva, ne jen odmítnutý požadavek. Kroky handleru, které proběhly před výjimkou (např. založení adresy nebo zákazníka
před
createOrder), proběhnou znovu. Handler opakovaný tímto způsobem musí být idempotentní – před založením ověřit, zda záznam už neexistuje, a přeskočit hotové kroky. Idempotence je nutná i proto, žeRateLimitExceptionz jiné odpovědi 429 než od Depoto serveru (viz výše) nezaručuje, že odmítnutý požadavek neproběhl. U handleru, který idempotentní není, raději zvolte omezený počet opakování (výjimku jen propustit aretry_strategynastavit na prodlevy v řáduRetry-After) než neomezené opakování přesRecoverableMessageHandlingException. - Na
RateLimitExceptionnereagujte náhradním pokusem s jinými daty (např. „zkusit znovu bez balíků“) – výjimku propusťte ven. Náhradní volání by po uvolnění limitu prošlo a část původních dat by se tiše ztratila. - Mimo Messenger (cron, fronta úloh) nechte úlohu selhat a naplánujte ji znovu (za
getRetryAfter()sekund, nejméně za 1 s), neoznačujte ji jako hotovou.
Ouery
Detail produktu
Výpis produktů
Detail objednávky
Výpis objednávek
Mutation
Vytvoření produktu
Úprava produktu
Vytvoření souboru/obrázku
Vytvoření zákazníka
Vytvoření adresy
Vytvoření objednávky
Přidání položky do objednávky
Úprava položky objednávky
Smazání položky objednávky
Úprava objednávky
Zrušení rezervace
Zručit jde jen objednávky ve stavu rezervace (status="reservation").
Vytvoření skladového pohybu
All versions of depoto-php-client with dependencies
ext-json Version *
himik/simple-graphql-query-builder Version ^0.2.4
psr/log Version >=1.1
psr/log-implementation Version *
psr/http-client Version ^1.0
psr/http-client-implementation Version *
psr/http-factory Version ^1.0
psr/http-factory-implementation Version *
psr/http-message Version ^1.0
psr/http-message-implementation Version *
psr/simple-cache Version ^1.0
psr/simple-cache-implementation Version *