# i3X API

> Bir Proxus hub'ının tesis modelini, canlı değerlerini ve geçmişini CESMII i3X 1.0 arayüzüyle okuyun; i3X istemcileri özel kod yazmadan çalışır.

Kaynak: https://proxus.io/tr/docs/develop/i3x

Hub, tesisi **CESMII i3X 1.0** (Industrial Information Interoperability eXchange) arayüzüyle sunar; üretim verisi
için üreticiden bağımsız bir REST arayüzüdür. Bir i3X istemcisi tesis ağacını, makine tiplerini, her cihazı tipinin
biçiminde, son değerleri ve geçmişlerini okur. Arayüz yalnızca okumak içindir. CESMII i3X uyumluluk test paketi onu
**1.0 Compatible** olarak değerlendirir: zorunlu davranışların hepsi ve akış geçer; isteğe bağlı olan değer yazma
sunulmaz.

Temel adres `https://<hub>/api/i3x/v1`'dir. `GET /info` oturum açmadan cevap verir; diğer bütün çağrılar
[REST API](https://proxus.io/tr/docs/develop/rest-api#adım-1-erişim-anahtarı-alın) ile aynı erişim anahtarını `Authorization: Bearer` başlığında
ister. Çağıran yalnızca rolünün görebildiklerini görür.

## İstemcinin bulduğu

| i3X | Proxus'ta |
| --- | --- |
| Ad alanları | `urn:proxus:i3x` (tesis seviyeleri, değer tipleri, ilişkiler) ve `urn:proxus:machinetypes` (makine tipleri). |
| Nesne tipleri | Her [makine tipi](https://proxus.io/tr/docs/organize/machine-types) bir JSON Schema olarak: alanları veri türü, birimi (`x-unit`) ve sınırlarıyla; üzerine kurulduğu tipin alanları ve bileşenleri açılmış halde. Tesis seviyeleri ve değer tipleri (`number`, `integer`, `boolean`, `string`) kendi tiplerine sahiptir. |
| Kök nesneler | Tesis ağacının tepesi (kuruluş ya da tesis). Her yerin altında, altındaki yerler ve cihazlar vardır (`HasParent` / `HasChildren`). |
| Cihazlar | Her cihaz, makine tipiyle tiplenmiş bir nesnedir (tipi yoksa `UnknownType`). Bileşenleri ve eşlenmiş alanları onu oluşturan çocuklarıdır (`HasComponent` / `ComponentOf`). |
| Değerler | Bir alanın değeri, eşlendiği veri noktasının son değeridir; kalitesi ve zamanıyla. Bir cihazın değeri, alanlarından oluşan nesnedir; `maxDepth` 0 ya da 2 bileşenlerini de getirir. |
| Geçmiş | `POST /objects/history` bir alanın aralıktaki değerlerini saklanan okumalardan getirir. |
| Abonelikler | Sync: her `/subscriptions/sync` çağrısı bir öncekinden beri değişenleri, onaylanacak sıra numaralarıyla getirir. Akış: `/subscriptions/stream` Server-Sent Events açar ve her değişikliği görüldüğü anda gönderir (son değerler saniyede bir okunur); yeni bir akış açık olanı kapatır, akış açıkken sync beklenir. |

Öğe kimlikleri değişmez: `place:<id>`, `device:<id>` ve bir alan için `device:<id>/<alan>` (bir bileşen alanı için
`device:4/Main/Speed`). Hesaplanan alanlar henüz sunulmuyor.

## Deneyin

```bash
TOKEN=$(curl -s -X POST http://localhost:8080/api/Authentication/Authenticate \
  -H "Content-Type: application/json" -d '{"userName":"Admin","password":""}')
curl -s http://localhost:8080/api/i3x/v1/objects?root=true -H "Authorization: Bearer $TOKEN"
curl -s -X POST http://localhost:8080/api/i3x/v1/objects/value -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" -d '{"elementIds":["device:5"],"maxDepth":0}'
```

## Sonraki adımlar

- [Makine tipleri](https://proxus.io/tr/docs/organize/machine-types): i3X'in sunduğu tipler.
- [REST API](https://proxus.io/tr/docs/develop/rest-api): belirteçler ve hub'ın kendi API'si.
