Ana içeriğe geç

API Anahtarları

API Anahtarları,Anahtarları, Useroam'unUseroam RESTpaneline API'sinebaşka dışarıdanbir erişmekyazılımın (otomasyon aracı, kendi uygulamanız, raporlama sisteminiz) güvenli şekilde bağlanması için tokenanahtar ürettiğiniz sekmedir.yerdir. Otomasyon araçları (n8n gibi), kendi mobil uygulamanız veya bir entegrasyon buradan üretilen anahtarla panele bağlanır.

Bu ekranı nasıl açarım?Anahtar, Profilim ekranınıekranının açıpAPI Anahtarları sekmesindedir.

Ne işe yarar?

Bir yazılım bu anahtarla cihaz listesini, 5651 imzalı log dosyalarını ve silinecek ya da çıkış yapacak kullanıcı listelerini okuyabilir. Anahtar yalnız sizin belirlediğiniz IP adreslerinden çalışır.

Ne zaman kullanılır?

  • Bilgi işlem ekibiniz 5651 loglarını kendi arşivine otomatik çekmek istediğinde.
  • n8n, Zapier gibi bir otomasyon aracını panele bağlarken.
  • Bir entegratör ya da yazılımcı sizden "API anahtarı" istediğinde.

Böyle bir ihtiyacınız yoksa bu sekmeyi kullanmanız gerekmez.

Başlamadan önce

  • Anahtarı kullanacak sunucunun dış IP adresini öğrenin (yazılımcınız verir). Örnek: 203.0.113.10 ya da bir ağ bloğu 203.0.113.0/24.
  • Anahtar sizin kullanıcınıza bağlıdır. Her entegrasyon için ayrı anahtar üretin; biri sızarsa yalnız onu iptal edersiniz.

Adım adım

Adım 1: API Anahtarları sekmesini açın

Üst çubuktaki kişi simgesiyle Profilim'i açın ve API Anahtarları sekmesine geçin.

Başlıkta
API

1.Anahtarlarınız ve "REST API erişimi için token üretin. Her token belirli IP adresleriyle sınırlandırılır." yazar. Hiç anahtarınız yoksa ortada "Henüz API anahtarınız yok. Yeni anahtarbir oluşturma

tane

oluşturmak için yukarıdaki butonu kullanın." görünür. Sağdaki Yeni Anahtar düğmesidüğmesine üçbasın.

alanlı

API Anahtarları sekmesi boş hali, Yeni Anahtar düğmesi işaretli

bir

Adım pencere2: açar:Etiket, IP ve süreyi yazıp Oluştur'a basın

Yeni API Anahtarı penceresi açılır:

  • Etiket:Etiket *: Anahtarınanahtarın neredene kullanıldığınıiçin ayırtolduğunu etmenizihatırlatacak sağlarad. —Örnek: ör. n8n entegrasyonu, Mobile App, Test. AnahtarıEn iptalfazla etmeniz120 gerektiğinde hangisi olduğunu bu addan bulursunuz.karakter.
  • IP Whitelist:Whitelist *: anahtarın kullanılabileceği AnahtarınIP kullanılabileceğiadresleri. adresler.Her Teksatıra adres,bir IP ya da ağ bloğu yazın (10.0.0.0/24) veya virgülle ayrılmışayırmak listeda yazılabilir.olur). Bu adresler dışından gelen istekler reddedilir. HerBoş token belirli IP'lerle sınırlandırılırolamaz. — bu alanı doldurmak güvenliğin ana katmanıdır.
  • Geçerlilik Süresi (gün): Anahtarınvarsayılan kaç365 gün sonra(1 sonayıl), ereceği.en fazla 3650 (10 yıl). Süre dolunca anahtar kendiliğinden çalışmaz.

Sarı kutu uyarır: "Oluşturulan anahtar sadece bir kez görüntülenir. Hemen kopyalayıp güvenli bir yere kaydedin." Oluştur'a anahtarıbasın üretir, (Vazgeç pencereyi kapatır.kapatır).

Yeni API Anahtarı penceresi, üç alan işaretli

Adım 3: Anahtarı hemen kopyalayın

Sekmenin üstünde yeşil Yeni API Anahtarı oluşturulduğu anda kopyalayın.Oluşturuldu Token'larkutusu güvenlikçıkar: gereği"[etiket] sonradanetiketli açıkanahtarınız hâldehazır." gösterilmez;ve kaybedersenizkırmızı yenisini"Bu üretmenizanahtar gerekir.

SADECE
BİR
KEZ

2.görüntülenir. Şimdi kopyalayıp güvenli bir yere kaydedin." Anahtar listesi

usr_

Üretilmişile anahtarlarbaşlar. tablodaKopyala'ya listelenir:

basın
    (düğme
  • Etiket:Kopyalandı Verdiğinizolur) ad.
  • ve
  • Anahtar:anahtarı Token'ınyazılımcınıza kısaltılmışgüvenli hâli.
  • bir
  • yoldan iletin. Kutunun altında IP Whitelist: İzin verilen adresler.
  • Oluşturulmawhitelist ve Bitiş:Geçerlilik Üretimtarihi yazar. Sayfayı yenilediğinizde bu kutu kaybolur ve son kullanma tarihi.
  • Son Kullanım: Anahtarın en son ne zaman kullanıldığı. Hiç kullanılmamışanahtar bir anahtar,daha unutulmuş bir entegrasyon demektir — silmek en doğrusu.
  • Kullanım: Toplam çağrı sayısı.
  • Durum: Anahtarın aktif olup olmadığı.

3. Endpoint listesi

gösterilmez.

SayfanınYeni anahtar kutusu ve Kopyala düğmesi işaretli; altında anahtar listesi (örnek veri, anahtar maskelendi)

altında

Adım API'nin4: sunduğuKullanım uçbilgisini noktalaryazılımcınıza Endpointverin

ve

Başlığın Açıklama sütunlarıyla listelenir. Hangi veriye nereden ulaşacağınızı buradan görür,altındaki Nasıl kullanılır? bağlantısındanbağlantısı ayrıntılıAPI belgeyeNasıl geçersiniz.Kullanılır? penceresini açar. Buradaki adres (https://panel.useroam.com/api/v1/), Kimlik Doğrulama bilgisi (her istekte Authorization: Bearer <token> başlığı), Endpoint'ler tablosu ve Önemli Notlar yazılımcınızın ihtiyaç duyduğu her şeydir.


API Nasıl Kullanılır penceresi

EndpointAçıklama
GET /me.phpToken sahibinin bilgisi
GET /devices.phpErişilebilir cihazlar
GET /logs.php?nasid=X5651 imzalı loglar (her log için imzalı indirme adresi)
GET /delete-users.php?nasid=XSilinecek kullanıcılar
GET /logout-users.php?nasid=XÇıkış yapacak kullanıcılar

Önemli Notlar: her istek IP whitelist'inizdeki IP'lerden gelmelidir; log indirme adresleri 5 dakika geçerlidir (HMAC imzalı); bir anahtar kaybedilirse hemen iptal edip yenisini oluşturun; tüm API kullanımı denetim kaydına işlenir.

Adım 5: Gereksiz ya da sızan anahtarı iptal edin

Listede aktif bir anahtarın satırının sonundaki kırmızı çarpı düğmesine (İptal Et) basın. Tarayıcı "Bu API anahtarını iptal etmek istediğinize emin misiniz? Bu işlem geri alınamaz." diye sorar; Tamam deyin. "API anahtarı iptal edildi." mesajından sonra satır gri İptal rozetiyle listenin altına iner ve o anahtarla yapılan istekler reddedilir.

Anahtar listesi, aktif satırda kırmızı iptal düğmesi

Anahtar listesi sütunları

SütunNe gösterir
EtiketVerdiğiniz ad.
AnahtarAnahtarın ilk 12 karakteri (usr_3f9a1c2b...). Anahtarın tamamı bir daha gösterilmez.
IP Whitelistİzin verilen adresler.
Oluşturulma / BitişÜretim zamanı ve son geçerlilik günü.
Son KullanımEn son kullanıldığı zaman ve hangi IP'den; hiç kullanılmadıysa çizgi.
KullanımToplam istek sayısı.
DurumAktif (yeşil), Süresi Dolmuş (sarı) ya da İptal (gri). Aktif olmayan satırlar soluk görünür.
(son sütun)Yalnız aktif anahtarlarda İptal Et düğmesi.

Uyarı ve hata mesajları

MesajNe yapmalısınız
API anahtarı oluşturuldu. AŞAĞIDA SADECE BİR KEZ görüntülenecek, kopyalayın.Anahtarı hemen kopyalayın.
Etiket zorunludur (max 120 karakter).Kısa bir ad yazın.
IP whitelist boş olamaz. Her IP veya CIDR değerini yeni satıra veya virgülle yazın.En az bir IP adresi yazın.
Geçersiz IP: ... / Geçersiz CIDR: ...Adresi 203.0.113.10 ya da 203.0.113.0/24 gibi yazın.
En az 1 geçerli IP/CIDR girilmeli.Geçerli bir adres ekleyin.
Geçerlilik süresi 1-3650 gün aralığında olmalıdır.1 ile 3650 arasında bir sayı yazın.
API anahtarı oluşturulamadı.Tekrar deneyin.
API anahtarı iptal edildi.İptal başarılı.
Anahtar bulunamadı veya zaten iptal edilmiş. / Geçersiz anahtar.Sayfayı yenileyin; anahtar zaten iptal edilmiş olabilir.

Sık sorulanlar

Anahtarı kopyalamayı unuttum. Tekrar gösterilemez. Eski anahtarı iptal edip yenisini oluşturun.

Süresi dolan anahtarı uzatabilir miyim? Hayır. Yeni anahtar oluşturup yazılımınızda değiştirin.

"Son Kullanım" hep çizgi. Anahtar hiç kullanılmamış. Unutulmuş bir entegrasyonsa iptal etmek en güvenlisidir.

İlgili sayfalar:sayfalar

Başlangıç
  • 5651 Logları
  • İşlem Kayıtları