API – Hermetry

Hermetry’nin kendi sistemlerinizin kuruluşunuzla çalışması için üç yolu ve cihazlar için ayrı bir API’si vardır. Bu bölüm ilk üç yolu kapsar.

Arayüz	Yön	Kimler kullanır	Giriş
Yönetim REST API	Sisteminiz Hermetry’yi çağırır	ERP’ler, MES, destek talebi sistemleri, betikler, raporlar	API anahtarı
Webhook’lar	Hermetry sisteminizi çağırır	Olaylara tepki vermesi gereken her şey: bir cihazın çevrimdışı olması, bir alarmın açılması, bir komutun sonlanması	Doğruladığınız bir imzalama sırrı
MCP sunucuları	Bir yapay zeka asistanı Hermetry’yi çağırır	MCP desteği olan yapay zeka asistanları	API anahtarı veya oturum açma (OAuth)
Cihaz API’si	Cihazlar veri gönderir ve komut alır	Cihazlar ve ağ geçitleri	Cihaz belirteci, MQTT kullanıcı adı ve parola veya sertifika

Cihaz API’si şu şekilde belgelenmiştir: MQTT, Cihaz HTTP API’si ve MQTT konuları ve yük verileri. Bir cihazda API anahtarı kullanmayın ve bir entegrasyonda cihaz belirteci kullanmayın.

Yönetim API’si ile neler yapabilirsiniz

Bir API anahtarıyla, anahtara verdiğiniz izinler dahilinde, uygulamada bir üyenin yapabildiği her şeyi koddan yapabilirsiniz:

cihazları ve cihaz profillerini listeleme, oluşturma, değiştirme ve silme ile cihaz kimlik bilgilerini döndürme,
öznitelikleri okuma ve yazma, en son değerleri ve telemetrinin geçmişini okuma,
cihazlara komut gönderme ve sonuçlarını okuma,
alarmları listeleme, onaylama ve çözümleme ile bir profilin alarm kurallarını değiştirme,
site ve varlık ağacını oluşturma ve okuma ile cihazları bu ağaca yerleştirme,
yazılım sürümlerini kaydetme, dağıtımları başlatma ve cihaz ayarlarını değiştirme,
LoRaWAN ağ geçitlerini ve cihazlarını yönetme.

REST API’de telemetri yazmak için bir rota yoktur. Okumalar cihazlardan (MQTT veya HTTP) ya da akışlardan gelir.

API Anahtarları bölümünü açın ve cihazlar modülünün Yalnızca okuma ön ayarıyla bir anahtar oluşturun. Bkz. Kimlik doğrulama.
Kuruluş kimliğinizi (tenantId) uygulamanın adres çubuğunda bulun: https://<your host>/tenant/<tenantId>/admin/....
Cihaz listesini çağırın:

curl -s "https://<your host>/tenant/<tenantId>/api/iot/devices?pageSize=5" \
  -H "Authorization: Bearer sk_live_…"

Yanıt { "devices": [...], "total": 42 } biçimindedir.

Başlangıç:

Kimlik doğrulama: API anahtarları, izinler, ağlar, son kullanma, döndürme.
REST API temelleri: yollar, listeler, sayfalama, sıralama, filtreler ve kurallar.
Hatalar ve hız sınırları: hata gövdesi, her durum kodu ve 429 yanıtına yol açan sınırlar.

Rota başvuruları:

Olaylar:

Yapay zeka asistanları:

Her entegrasyona yalnızca ihtiyaç duyduğu izinlerle kendi anahtarını verin. Bkz. API anahtarı sertleştirme.
429 yanıtını bekleyin ve Retry-After değerine uyun.
Kimlikleri opak UUID olarak ele alın. Bunları kendiniz üretmeyin.
Değişiklikler için yoklama yerine webhook’ları tercih edin: bir cihazın bağlantısı, bir alarm, bir komut sonucu.
API anahtarları ve webhook’lar yöneticiler tarafından yönetilir. Bir webhook’un imzalama sırrını döndürmek Sahip rolü gerektirir.