API Anahtarları

API Anahtarları,Anahtarları, Useroam paneline başka bir yazılımın (otomasyon aracı, kendi uygulamanız, raporlama ya da CRM 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 cihazpanelde listesini,gördüğünüz raporların hemen hepsini otomatik çekebilir: 5651 imzalı logloglar, dosyalarınıhotspot kullanımı (bağlı misafir, tekil ziyaretçi, yoğun saatler), Bumerang kampanya sonuçları, anket cevapları, QR menü siparişleri, otel talepleri, görev/bakım/stok raporları, etkinlik katılımı ve silinecekretail raporları.

Her anahtar tek bir cihaza bağlıdır. Anahtar, üretildiği anda panelde seçili olan cihazın verisini görür; başka cihazın ya da çıkışbaşka yapacakmüşterinin kullanıcıverisine listelerinierişemez. okuyabilir.Birden Anahtarfazla yalnızcihazınız sizinvarsa belirlediğinizher IPcihaz adreslerindeniçin çalışır.ayrı anahtar üretin.

Ne zaman kullanılır?

• Bilgi işlem ekibiniz 5651 loglarını kendi arşivine otomatik çekmek istediğinde.
• Raporları kendi raporlama sisteminize (Power BI, Excel, Google Sheets) aktarmak istediğinizde.
• 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

• Panelin üst kısmından anahtarı üreteceğiniz cihazı seçin. Anahtar o cihaza bağlanır.
• Anahtarı kullanacak sunucunun dış IP adresini öğrenin (yazılımcınız verir). Örnek: 203.0.113.10 ya da en fazla 256 adreslik bir ağ bloğu 203.0.113.0/24.
• AnahtarYazılımın sizinhangi kullanıcınızaverilere bağlıdır.ihtiyacı Herolduğunu entegrasyonöğrenin; yalnız onları açacaksınız.
• Anahtarı yalnız o cihazda tam yetkili kullanıcılar üretebilir. Yetkiniz kısıtlıysa sekmede "Bu cihaz için ayrıAPI anahtaranahtarı üretin;yönetme biriyetkiniz sızarsayok." yalnızyazar onuve iptalYeni edersiniz.Anahtar düğmesi pasif olur; hesap yöneticinizden isteyin.

Adım adım

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

Üst çubuktaki kişi simgesiyle Profilim'Profilim'i açın ve API Anahtarları sekmesine geçin. BaşlıktaBaşlığın API Anahtarlarınız vealtında "RESTBu APIanahtarlar erişimiyalnız içinşu tokencihazın üretin.verisine Hererişir: tokencihaz belirli IP adresleriyle sınırlandırılır.adı" yazar.yazar; doğru cihazda olduğunuzu buradan kontrol edin. Hiç anahtarınızanahtar 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.

Adım 2: Etiket, IPIP, erişim ve süreyi yazıpseçip Oluştur'a basın

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

• Etiket *: anahtarın ne için olduğunu hatırlatacak ad. Örnek: n8nPower entegrasyonuBI raporları, MobileLog App, Testarşivi. 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). Ağ bloğu en fazla /24 (256 adres) olabilir; 0.0.0.0/0 gibi geniş bloklar kabul edilmez. Bu adresler dışından gelen istekler reddedilir.
• Neye erişebilsin? *: anahtarın okuyabileceği veriler. Yalnız gerekenleri işaretleyin:
  • 5651 imzalı loglar (varsayılan işaretli)
  • Hotspot kullanımı: bağlı misafirler, tekil ziyaretçi, yoğun saatler, giriş başarısı, Rapor Dışı Kullanıcılar
  • Bumerang kampanyaları, BoşAnketler, olamaz.QR Menü, Otel, Operasyon (restoran, görev, bakım, stok), Etkinlik, Retail ve kupon
  • Misafir listesi ve pazarlama izinleri: kişisel veri içerir (telefon, ad, e-posta). Varsayılan kapalıdır; yalnız gerçekten gerekiyorsa açın. Kapalıyken raporlardaki telefon ve adlar maskeli gelir (ör. 5307****73).
• Geçerlilik Süresi (gün): varsayılanen fazla 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 sadeceyalnız bir kez görüntülenir. Hemen kopyalayıp güvenli bir yere kaydedin."gösterilir. Oluştur'a basın (Vazgeç pencereyi kapatır).

basın.

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."çıkar. 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.

Adım 4: KullanımDoküman bilgisinibağlantısını yazılımcınıza verin

Başlığın altındaki API dokümanı (tüm uçlar) bağlantısı ya da Nasıl kullanılır? bağlantısıpenceresindeki APIdüğme, Nasıltüm Kullanılır?uçların penceresiniparametrelerini, açar.gereken Buradakierişim adrestürünü (ve örnek yanıtları gösteren doküman sayfasını açar: panel.useroam.com/api/docs. Yazılımcınızın ihtiyaç duyduğu her şey oradadır; sayfada istekleri tarayıcıdan deneyebilir.

Kısaca kullanım:

1. Her istekte Authorization: Bearer usr_... başlığı gönderilir.
2. Önce GET https://panel.useroam.com/api/v1/devices.php çağrılır; dönen nasid değeri (şifreli bir metin, ör. OT37I3...) diğer tüm isteklerde nasid parametresi olarak kullanılır. Cihazın panelde gördüğünüz numarası çalışmaz.
3. Hazır raporların listesi için reports.php?nasid=..., Kimlikbir Doğrulamaraporu bilgisiçalıştırmak (her istekteiçin Authorization:reports.php?nasid=...&key=gunluk_ziyaret_trendi&gun=30.
Bearer <token> başlığı), Endpoint'ler tablosu ve Önemli Notlar yazılımcınızın ihtiyaç duyduğu her şeydir.

EndpointUç	AçıklamaNe verir	Gereken erişim
GETme.php, /me.devices.php	Token sahibininAnahtarın bilgisi ve bağlı olduğu cihaz	Her anahtar
GET /devices.reports.php	Erişilebilir70'i cihazlaraşkın hazır rapor (her raporun kendi modülü)	Raporun modülü
GET /logs.php?nasid=Xphp	5651 imzalı loglar (her log içinlistesi ve indirme adresleri	5651 imzalı indirme adresi)loglar
GET /delete-users.php?nasid=Xhotspot.php	SilinecekKullanım kullanıcılarözeti ve günlük seri; Rapor Dışı Kullanıcılar raporu	Hotspot kullanımı
GET /logout-users.php?nasid=Xbumerang.php	ÇıkışKampanyalar, yapacaksonuçlar, kullanıcılargönderimler	Bumerang kampanyaları
anket.php	Anketler, soru dağılımları, NPS, ham cevaplar	Anketler
menu.php, menu-report.php	Menü analitiği, siparişler, çağrılar, görüşler	QR Menü
otel.php, otel-report.php	Otel talepleri, hız paketi satışları	Otel
operasyon.php	Görev panosu, restoran talepleri, bakım, stok	Operasyon
etkinlik.php	Etkinlikler, katılım raporu, katılımcılar	Etkinlik
retail-report.php, coupon-redeem.php	Retail raporu, kupon doğrulama ve kullanma	Retail ve kupon
guests.php, consents.php, logout-users.php, delete-users.php	Misafir listesi, pazarlama izinleri, çıkış/silme talepleri	Misafir listesi ve pazarlama izinleri

Önemli Notlar:notlar: her istekistekler IP whitelist'inizdeki IP'lerdenadreslerden gelmelidir; log indirme adresleri 5 dakika geçerlidirgeçerlidir; (HMACanahtarın imzalı);erişimi olmayan bir anahtaruca kaybedilirseistek hemen403 iptalscope_denied edip yenisini oluşturun;döner; 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.basın Tarayıcıve "Buonaylayın. 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ırSatır gri İptal rozetiyle listenin altına iner ve o anahtarla yapılan istekler reddedilir.

Cihazda tam yetkili her kullanıcı, kimin ürettiğine bakmaksızın o cihazın anahtarlarını iptal edebilir.

Anahtar listesi sütunları

Sütun	Ne gösterir
Etiket	Verdiğiniz ad.
Anahtar	Anahtarın ilk 12 karakterikarakteri. (usr_3f9a1c2b...). Anahtarın tamamıTamamı bir daha gösterilmez.
IP Whitelist	İzin verilen adresler.
Erişim	Anahtarın okuyabildiği veriler (ör. 5651 imzalı loglar, QR Menü).
Oluşturan	Anahtarı üreten kullanıcı.
Oluşturulma / Bitiş	Üretim zamanı ve son geçerlilik günü.
Son Kullanım	En son kullanıldığı zaman ve hangi IP'den;IP; hiç kullanılmadıysa çizgi.
Kullanım	Toplam istek sayısı.
Durum	Aktif (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.

Liste, o an seçili cihazın tüm anahtarlarını gösterir.

Uyarı ve hata mesajları

da

Mesaj	Ne yapmalısınız
Bu cihaz için API anahtarı oluşturuldu.yönetme AŞAĞIDAyetkiniz SADECE BİR KEZ görüntülenecek, kopyalayın.yok.	AnahtarıHesap hemenyöneticinizden kopyalayın.anahtar üretmesini isteyin.
En az bir erişim türü seçin.	"Neye erişebilsin?" altından en az bir kutu işaretleyin.
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 gibi yazın.
Geçersiz ya da çok geniş IP bloğu (en fazla /24): ...	Bloğu 203.0.113.0/24 gibiya yazın.
Endaha azdar 1yazın; geçerlidaha IP/CIDRgeniş girilmeli.	Geçerlibloklar birgüvenlik adresiçin ekleyin.kabul edilmez.
Geçerlilik süresi 1-3650365 gün aralığında olmalıdır.	1 ile 3650365 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.

Birden fazla cihazımın verisini tek anahtarla çekebilir miyim? Hayır. Güvenlik için her anahtar tek cihaza bağlıdır; her cihaz için ayrı anahtar üretin.

Raporlarda telefonlar yıldızlı geliyor. Anahtarda "Misafir listesi ve pazarlama izinleri" kapalı. Gerçekten gerekiyorsa bu erişimle yeni bir anahtar üretin.

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

"SonCihazı Kullanım" hep çizgi. Anahtar hiç kullanılmamış. Unutulmuşbaşka bir entegrasyonsahesaba iptaltaşıdık. etmekO encihaz güvenlisidir.için üretilmiş anahtarlar kendiliğinden çalışmaz hale gelir; yeni hesapta yeni anahtar üretin.

İlgili sayfalar

• Profilim (Hesap Bilgileri)
• 5651 Logları
• İşlem Kayıtları