PHPackages                             ispalliance/codi-integration - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. ispalliance/codi-integration

ActiveLibrary

ispalliance/codi-integration
============================

v0.5.1(7y ago)21.1kMITPHPPHP &gt;=5.6

Since Jan 2Pushed 7y ago6 watchersCompare

[ Source](https://github.com/ispalliance/codi-integration)[ Packagist](https://packagist.org/packages/ispalliance/codi-integration)[ RSS](/packages/ispalliance-codi-integration/feed)WikiDiscussions master Synced 2d ago

READMEChangelog (2)Dependencies (1)Versions (3)Used By (0)

CODI integrace
==============

[](#codi-integrace)

[![PHP from Packagist](https://camo.githubusercontent.com/d4629d899176a535f09d5e7357abe161d248f69f8c599b8a0e3bee3e7cbb9f8a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f697370616c6c69616e63652f636f64692d696e746567726174696f6e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/ispalliance/codi-integration)[![Build Status](https://camo.githubusercontent.com/ba90aa802bd431da3695b3a81c27cec9aa7f994036c22ee19fcaf4ea59e1b032/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f697370616c6c69616e63652f636f64692d696e746567726174696f6e2e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/ispalliance/codi-integration)[![Code coverage](https://camo.githubusercontent.com/f51b9dfe9d399e5c574e83c614d477cb3835439bb31b2f8cea7889ee580432f0/68747470733a2f2f696d672e736869656c64732e696f2f636f766572616c6c732f697370616c6c69616e63652f636f64692d696e746567726174696f6e2e7376673f7374796c653d666c61742d737175617265)](https://coveralls.io/r/ispalliance/codi-integration)[![Licence](https://camo.githubusercontent.com/fe4ef95d9cf51d05b8ace9290eefbf7ad6087457a43cb38a2441141efa8a664a/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f697370616c6c69616e63652f636f64692d696e746567726174696f6e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/ispalliance/codi-integration)[![Downloads this Month](https://camo.githubusercontent.com/f20387dbebcd2feaf8710293a9e323b579d7a51b423f5ef1f4d7e5ff2926c244/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f646d2f697370616c6c69616e63652f636f64692d696e746567726174696f6e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/ispalliance/codi-integration)[![Downloads total](https://camo.githubusercontent.com/8cc36b91f6cdce119d8457facdad29c3092750e5c77abd6352e9cb7806a5ebe9/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f697370616c6c69616e63652f636f64692d696e746567726174696f6e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/ispalliance/codi-integration)[![Latest stable](https://camo.githubusercontent.com/0df3f3a54ab3e274dd4621c78b1c8c1525730a29b0c89ec88186d73387e767f6/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f697370616c6c69616e63652f636f64692d696e746567726174696f6e2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/ispalliance/codi-integration)

Základní entity, dokumentace, popis API a příklady k integraci platformy CODI do vašich systémů.

Instalace
---------

[](#instalace)

```
composer require ispalliance/codi-integration

```

Volání
------

[](#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

```
https://domain.tld/open-access.php?ruian=9268979

```

```
https://domain.tld/internet.php?ruian=9268979

```

Odpověď
-------

[](#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.

```
{
  "status":"success",
  "data":[
    ...
  ]
}
```

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

[](#internet)

Pro php lze využít CodiInternetResponseEntity

#### Ukázka implementace

[](#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](examples/Internet.php)

#### Položky entity:

[](#položky-entity)

```
objekt CodiInternetResponseEntity:
technology - string *
speedUp    - objekt FromToEntity *
speedDown  - objekt FromToEntity *
price      - objekt FromToEntity *
additional - pole stringu *
webLink    - string
orderLink  - string
promoText  - string, maximální dílka 100 znaků, delší text bude zkrácen.

```

```
objekt FromToEntity:
    from - int
    to   - int

```

\* povinné položky

#### Příklad json entity:

[](#příklad-json-entity)

```
{
  "technology":"fwa_licensed",
  "speedUp":{
    "from":10,
    "to":20
  },
  "speedDown":{
    "from":20,
    "to":40
  },
  "price":{
    "from":189,
    "to":799
  },
  "additional":["TV","VOIP"],
  "webLink":"http://www.ispalliance.cz",
  "orderLink":"http://ispalliance.cz/order",
  "promoText":"Akční nabídka."
}
```

#### Příklad odpovědi bez technologie:

[](#příklad-odpovědi-bez-technologie)

```
{
  "status":"success",
  "data":[]
}
```

#### Příklad minimální odpovědi, která vrací jen technologii:

[](#příklad-minimální-odpovědi-která-vrací-jen-technologii)

```
{
 "status":"success",
 "data":[
   {
     "technology":"fwa_licensed",
     "speedUp":{
       "from":null,
       "to":null
     },
     "speedDown":{
       "from":null,
       "to":null
     },
     "price":{
       "from":null,
       "to":null
     },
     "additional":[],
     "webLink":null,
     "promoText":null
   }
 ]
}
```

#### Příklad kompletní odpovědi, která vrací 2 technologie:

[](#příklad-kompletní-odpovědi-která-vrací-2-technologie)

```
{
 "status":"success",
 "data":[
   {
     "technology":"fwa_licensed",
     "speedUp":{
       "from":10,
       "to":20
     },
     "speedDown":{
       "from":20,
       "to":40
     },
     "price":{
       "from":189,
       "to":799
     },
     "additional":["TV","VOIP"],
     "webLink":"http://www.ispalliance.cz",
     "orderLink":"http://ispalliance.cz/order",
     "promoText":"Máme nejlepší poměr cena výkon na trhu. Nyní navíc akční nabídku půl roku za polovic."
   },
   {
     "technology":"xdsl",
     "speedUp":{
       "from":10,
       "to":30
     },
     "speedDown":{
       "from":20,
       "to":60
     },
     "price":{
       "from":399,
       "to":1999
     },
     "additional":[],
     "webLink":"http://www.ispalliance.cz",
     "orderLink":"http://ispalliance.cz/order",
     "promoText":"Máme nejlepší poměr cena výkon na trhu. Nyní navíc akční nabídku půl roku za polovic."
   }
 ]
}
```

### OpenAccess

[](#openaccess)

Pro php lze využít CodiOpenAccessResponseEntity

#### Ukázka implementace

[](#ukázka-implementace-1)

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](examples/OpenAccess.php)

#### Položky entity:

[](#položky-entity-1)

```
technology - string *
note - string
priceLevel - string
speedDown - int
speedUp - int

```

\* povinné položky

#### Příklad json entity:

[](#příklad-json-entity-1)

```
{
  "technology":"fwa_licensed",
  "note":"Poznámka",
  "priceLevel": "level_a",
  "speedDown": 4096,
  "speedUp": 512
}
```

#### Příklad odpovědi bez technologie:

[](#příklad-odpovědi-bez-technologie-1)

```
{
  "status":"success",
  "data":[]
}
```

#### Příklad minimální odpovědi, která vrací jen technologii:

[](#příklad-minimální-odpovědi-která-vrací-jen-technologii-1)

```
{
 "status":"success",
 "data":[
   {
     "technology":"fwa_licensed",
     "note":null,
     "priceLevel":null,
     "speedDown":null,
     "speedUp":null
   }
 ]
}
```

#### Příklad kompletní odpovědi, která vrací 2 technologie:

[](#příklad-kompletní-odpovědi-která-vrací-2-technologie-1)

```
{
 "status":"success",
 "data":[
   {
     "technology":"xdsl",
     "note":"note",
     "priceLevel":null,
     "speedDown":null,
     "speedUp":null
   },
   {
     "technology":"fwa_licensed",
     "note":"Lorem ipsum, bla bla bla.",
     "priceLevel": "level_a",
     "speedDown": 4096,
     "speedUp": 512
   }
 ]
}
```

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity20

Limited adoption so far

Community11

Small or concentrated contributor base

Maturity49

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 87.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~276 days

Total

2

Last Release

2778d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/07e65576bd5b3c50b761ed2e78b8ffec8daeadb908a43a56470b07dbf9685837?d=identicon)[sparkcz](/maintainers/sparkcz)

---

Top Contributors

[![Jabqooo](https://avatars.githubusercontent.com/u/5718320?v=4)](https://github.com/Jabqooo "Jabqooo (21 commits)")[![sparkcz](https://avatars.githubusercontent.com/u/4996607?v=4)](https://github.com/sparkcz "sparkcz (3 commits)")

### Embed Badge

![Health badge](/badges/ispalliance-codi-integration/health.svg)

```
[![Health](https://phpackages.com/badges/ispalliance-codi-integration/health.svg)](https://phpackages.com/packages/ispalliance-codi-integration)
```

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
