Ana içeriğe geç

API Anahtarları

API Anahtarları, Useroam paneline başka bir yazılımın (otomasyon aracı, kendi uygulamanız, raporlama sisteminiz) güvenli şekilde bağlanması için anahtar ürettiğiniz yerdir. Anahtar, Profilim ekranının API 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 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 bir tane oluşturmak için yukarıdaki butonu kullanın." görünür. Sağdaki Yeni Anahtar düğmesine basın.

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

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

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

  • Etiket *: anahtarın ne için olduğunu hatırlatacak ad. Örnek: n8n entegrasyonu, Mobile App, Test. En fazla 120 karakter.
  • IP Whitelist *: anahtarın kullanılabileceği IP adresleri. Her satıra bir IP ya da ağ bloğu yazın (virgülle ayırmak da olur). Bu adresler dışından gelen istekler reddedilir. Boş olamaz.
  • Geçerlilik Süresi (gün): varsayılan 365 gün (1 yıl), 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 basın (Vazgeç pencereyi 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 kutusu çıkar: "[etiket] etiketli anahtarınız hazır." ve kırmızı "Bu anahtar SADECE BİR KEZ görüntülenir. Şimdi kopyalayıp güvenli bir yere kaydedin." Anahtar usr_ ile başlar. Kopyala'ya basın (düğme Kopyalandı olur) ve anahtarı yazılımcınıza güvenli bir yoldan iletin. Kutunun altında IP whitelist ve Geçerlilik tarihi yazar. Sayfayı yenilediğinizde bu kutu kaybolur ve anahtar bir daha gösterilmez.

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

Adım 4: Kullanım bilgisini yazılımcınıza verin

Başlığın altındaki Nasıl kullanılır? bağlantısı API Nasıl 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