Download the PHP package ispalliance/codi-integration without Composer
On this page you can find all versions of the php package ispalliance/codi-integration. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package codi-integration
CODI integrace
Základní entity, dokumentace, popis API a příklady k integraci platformy CODI do vašich systémů.
Instalace
Volání
Z CODI se volá server subjektu metodou GET s HTTP Basic authentication. Server/servery subjektu by měli mít endpointy pro internet a volitelně pro open access. V adrese volaného serveru je umístěn RUIAN CODE, pro který zjišťujeme dostupnost internetu / open accessu.
Příklad volání pro open access a internet, kde 9268979 je RUIAN CODE
Odpověď
Odpověď je očekávána jako json, který obsahuje status a data. Data obsahují pole entit, nalezených dle ruianu. Použité kódování je UTF-8.
Každá entita by měla reprezentovat unikátní technologii, která se na adrese nachází. V případě, že bude v odpovědi zasláno více entit se shodnou technologií, uloží se v CODI pouze ta první a ostatní budou zahozeny. Pokud není žádná technologie v objektu dostupná, je očekáváno prázné pole. V případě, že není objekt dle RUIAN CODE nalezen, je očekávána odpověď se statusem 404. V případě, že vše proběhlo v pořádku je očekávána odpověď se statusem 200 a status v jsonu success, viz. příklady.
V případě php je možné použít entity, které lze poté pomocí json_encode převést na json. V ostatních případech je vyžadován níže popsaný tvar jsonu.
Internet
Pro php lze využít CodiInternetResponseEntity
Ukázka implementace
Základní implementaci včetně HTTP Basic auth bez logiky získávání dat pro PHP naleznete v příkladech v souboru Internet.php
Položky entity:
* povinné položky
Příklad json entity:
Příklad odpovědi bez technologie:
Příklad minimální odpovědi, která vrací jen technologii:
Příklad kompletní odpovědi, která vrací 2 technologie:
OpenAccess
Pro php lze využít CodiOpenAccessResponseEntity
Ukázka implementace
Základní implementaci včetně HTTP Basic auth bez logiky získávání dat pro PHP naleznete v příkladech v souboru OpenAccess.php
Položky entity:
* povinné položky