Ana içeriğe geç

kommuns API

kommuns API, bir dış sistemin bir organizasyonun kommuns'taki verisiyle çalışmasını sağlar: envanteri, iş emirlerini ve geri bildirimleri okur, iş emri açar ve günceller, iş emirlerini form cevaplarıyla tamamlar ve bir şey olunca webhook ile haber alır.

Neler yapılıyor​

SenaryoSistemin yaptığı
ERP / bakım planlamaKendi planlarından iş emri açar, durumlarını ve cevaplarını geri okur, kendi numaralarını tutar (external_id).
Bina otomasyonu, SCADA, sensörlerBir alarm oluşunca geri bildirim (ya da iş emri) açar.
Raporlama (Power BI, Excel, veri ambarı)İş emirlerini ve cevapları sayfa sayfa, sonra yalnız değişenleri okur.
Servis firmasının kendi yazılımıMüşterilerinin kendisine atadığı iş emirlerini okur, cevaplarla tamamlar.
Otel ya da çağrı merkezi yazılımıBir oda ya da cihaz için geri bildirim açar ve çözülene kadar izler.

Erişim nasıl çalışır​

  1. Paket. API, organizasyonun kommuns paketinin bir özelliğidir; dakikalık çağrı sınırı ve entegrasyon sayısıyla.
  2. Entegrasyon. Organizasyonun bir yöneticisi Organizasyon › Entegrasyonlar'da bir entegrasyon oluşturur. Entegrasyonun bir istemci kimliği, bir istemci sırrı (bir kez gösterilir) ve kapsamları — API'de yapabilecekleri — olur.
  3. Yetkiler. Entegrasyon, organizasyonda bir çalışan gibi bir kimliktir: bir organizasyon yetki tanımıyla oluşturulur ve yalnız yetki verildiği envanteri görür (lokasyon, sistem ya da ekipmanda Yetkili Ata). Kapsamları bunu ayrıca daraltır: API'nin izin verdiği, kapsamlar ∩ yetkilerdir.
  4. Token'lar. Sisteminiz istemci kimliğini ve sırrını bir erişim token'ıyla değiştirir (OAuth 2 client credentials) ve her çağrıda gönderir.

Entegrasyonun yaptığı her değişiklik organizasyonun Log Kayıtları'na onun adıyla ("SAP bağlantısı (API)" gibi) yazılır; ilgili kişiler her zamanki bildirimleri alır.

Adresler​

Organizasyonunuz başka bir kommuns kurulumunu kullanıyorsa onun adresini kullanın.

Sonraki: İlk adımlar.