Getting Started

• Quick Start: Your First Sign-in
• Two-Factor Authentication (2FA)
• Agreement Approval
• Device Selection
• Panel Layout: Side Menu, Top Bar and Language
• Dashboard (Home Screen)
• What Do I Want To Do? Which Page?
• My Profile (Account Info)
• API Keys

Quick Start: Your First Sign-in

Signing in to the Useroam panel for the first time? This page takes you step by step from the sign-in screen to the home screen (Dashboard). It takes about 10 minutes. Keep your phone at hand: you will install a verification app on it.

What is it for?

It lets you sign in securely, prepares your account for first use and shows you where to do what.

When do I use it?

• When Useroam or your dealer sends you a panel username and password (first sign-in).
• When you forget your password or move to a new phone.
• When a new administrator in your team signs in for the first time: send them this page.

Before you start

• Your username (your e-mail address) and password, given to you by Useroam or your dealer.
• A smartphone with one of these free apps from the App Store or Google Play: Google Authenticator, Microsoft Authenticator or Authy.
• An up-to-date browser (Chrome, Edge, Safari, Firefox). Panel address: https://panel.useroam.com

Sign-in order (summary)

On your first sign-in the screens appear in this order. Later you are only asked for the 6-digit code instead of step 2's setup, and step 5 does not come back.

1. Sign-in screen: e-mail, password, language.
2. Two-factor authentication setup (first sign-in only).
3. Device Selection: which business (device) to open.
4. Company details (once, only if missing).
5. Agreement approval (once; again if a new version is published).
6. Dashboard (home screen).

Step by step

Step 1: Open the sign-in screen

Go to https://panel.useroam.com. You see the time and date at the top left, and the Useroam logo with the sign-in boxes in the middle.

Important: if you want to change the language, do it before typing your e-mail and password (Step 3). Changing the language reloads the page and empties the boxes.

Step 2: Type your e-mail and password, then press Login

Type your username in E-Mail and your password in Password, then press Login. The eye icon on the right of the password box shows what you typed.

The Login button runs an invisible robot check (Google reCAPTCHA) in the background; you are not asked to pick pictures. If a box is empty, This field is required appears under it.

Step 3 (optional): Choose the language

Choose Türkçe or English in the Language box. The page reloads in that language at once and your browser remembers the choice for one year. It also sets the panel language, unless you saved a panel language in My Profile, which then wins.

Step 4: Set up two-factor authentication (first sign-in only)

If your password is correct, the İki Adımlı Doğrulama Kurulumu (Two-Factor Authentication Setup) screen opens. This step is mandatory. Scan the QR code with the verification app on your phone and type the 6-digit code it shows. Full guide with screenshots: Two-Factor Authentication (2FA). This screen is currently shown in Turkish only.

On later sign-ins you only see the İki Adımlı Doğrulama (Two-Factor Authentication) screen and type the current 6-digit code from the app:

Step 5: Select your device

Next, the Device Selection screen opens. In Useroam every branch or guest Wi-Fi network is a "device" (the firewall or router guests connect through). Click the card of the device you want to manage. All features of this screen: Device Selection.

If the list is empty, no device has been assigned to you yet. Add one with the New Device button at the top right: Adding a New Device.

Step 6: Complete your company details (only if missing)

If your account has no company title or address, the Complete your company details screen opens after you pick a device. Enter the legal title and full address, then press Save and continue to the agreements.

Step 7: Approve the agreements (once)

The Approve the service agreements screen has two agreements. Scroll each one to its end inside its box, tick the box below it and press Okudum, tüm sözleşmeleri onaylıyorum (I have read and approve all agreements). Details: Agreement Approval.

Step 8: You have reached the Dashboard

After approval the Dashboard opens. The menu is on the left; language, profile and sign-out icons are at the top. Screen guide: Dashboard (Home Screen). Where everything is in the menu: Panel Layout: Side Menu, Top Bar and Language.

What should I do next?

If you are not sure where to start, see What Do I Want To Do? Which Page?. For most businesses the first three jobs are:

1. Set up the page guests see when joining the Wi-Fi: Portal Settings.
2. Add other administrators: Administrators.
3. Check your own profile and mobile number: My Profile.

Forgot password

Under the Login button there is a Forgot Password link. The View Live Demo button below it opens a sample panel without a password ("Sample panel, no password required; view only"); nothing is saved there.

1. Click Forgot Password. The Şifremi Unuttum (Forgot Password) screen opens (currently Turkish only).
2. Type your registered e-mail in the E-posta veya kullanıcı adı (e-mail or username) box and press Şifremi Sıfırla (Reset my password).

   

A message then says your new password will be e-mailed within a few minutes if the address is registered. The same message appears even if it is not registered (for security). Sign in with the new password from the e-mail; check your spam folder if it does not arrive. Resetting the password also resets two-factor authentication, so you will be asked to scan a QR code again (Step 4). Giriş Ekranına Dön (Back to sign-in) returns to the sign-in screen. To choose your own password afterwards, use the Change Password tab in My Profile.

Every field and button

Field / Button	What it does	Example
E-Mail	Your panel username.	ayse@mybusiness.com
Password	Your panel password. The eye icon shows it.
Language	Language of the sign-in screen and the panel.	Türkçe / English
Login	Checks your details and moves on to two-factor authentication.
Forgot Password	Opens the screen that e-mails you a new password.
View Live Demo	Opens a view-only sample panel without a password.
E-posta veya kullanıcı adı (Forgot Password)	Finds the account to send the new password to.	ayse@mybusiness.com
Şifremi Sıfırla	Creates a new password and e-mails it.

Warnings and errors

Message	Meaning	What to do
Username or password incorrect (red box)	Wrong e-mail or password.	Type again, watching upper and lower case. If it still fails, use Forgot Password.
Güvenlik doğrulaması başarısız. Lütfen tekrar deneyin. (Security check failed. Please try again.)	The robot check failed, usually after the page stayed open for a long time.	Refresh the page and try again.
This field is required	E-mail or password is empty.	Fill in the box.
Şifre sıfırlama isteğiniz alındı. Yeni bir istek için lütfen 5 dakika bekleyin. (Request received, please wait 5 minutes.)	A second reset request was made from the same computer within 5 minutes.	Wait 5 minutes and check your e-mail meanwhile.
E-posta veya kullanıcı adı zorunludur. (E-mail or username is required.)	The Forgot Password box is empty.	Type your e-mail.
Oturum doğrulaması başarısız. Sayfayı yenileyip tekrar deneyin. (Session check failed.)	The page stayed open too long.	Refresh the page.

Frequently asked questions

The reset e-mail did not arrive. Check spam. A second new password is not created for the same person within 10 minutes; wait for the first e-mail. If it still does not come, contact your panel administrator or Useroam support. The reset e-mail is currently in Turkish.

I changed phones and cannot generate a code. If you still have the old phone, reset it from My Profile, 2FA Management. If not, use Forgot Password: resetting the password also resets two-factor authentication and setup is asked again at sign-in.

I signed in but Device Selection is empty. No device has been assigned to your account yet. Add one with New Device or ask the administrator who added you for device access.

I cannot tick the agreement box. It becomes active when you scroll the agreement text to the very end inside its own box. Do this for both agreements.

I want to use the panel in English. Choose it in the Language box on the sign-in screen, or with the language icon in the top bar once inside.

Related pages

• Two-Factor Authentication (2FA)
• Agreement Approval
• Device Selection
• Panel Layout: Side Menu, Top Bar and Language
• What Do I Want To Do? Which Page?

Two-Factor Authentication (2FA)

Two-factor authentication (2FA) asks, in addition to your password, for a 6-digit code produced by an app on your phone. Even if someone learns your password, they cannot enter your account without your phone.

Note: the 2FA setup and code screens are currently shown in Turkish only. This page gives each Turkish label with its English meaning in parentheses.

What is it for?

It protects your account and your guests' personal data. 2FA is mandatory in the Useroam panel: every user sets it up at first sign-in and types a code on every sign-in.

When do I use it?

• On your first sign-in (the setup screen opens by itself).
• On every sign-in (the 6-digit code is asked).
• When you change phones or delete the app (you reset and set it up again).
• When you reset your password with Forgot Password (2FA is reset too and setup is asked again).

Before you start

• Install one of these free apps from the App Store or Google Play: Google Authenticator, Microsoft Authenticator or Authy. They work without internet.
• Make sure your phone's date and time are set automatically. If the clock is a few minutes off, codes are rejected.

Step by step: first setup

After signing in with e-mail and password, the İki Adımlı Doğrulama Kurulumu (Two-Factor Authentication Setup) screen opens. Follow the same order as its "Kuruluma 3 adımda hazır olun" (Get ready in 3 steps) list.

Step 1: Install the verification app

The first item of the list says: install Google Authenticator, Microsoft Authenticator or Authy on your phone. Open the app and tap "add account" (+).

Step 2: Scan the QR code (or type the key)

In the app choose "scan a QR code" and point the camera at the QR code on the screen. If you cannot use the camera, choose "enter a setup key" and type the Manuel kurulum kodu (manual setup key, letters and digits in groups of 4) shown next to the QR code. A new Useroam entry showing your e-mail appears in the app.

Under the QR code you see Hesap (Account: your e-mail) and Yayıncı (Issuer: Useroam). The QR code and key are blurred in this image for security; on your screen they are sharp. Never share this key.

Step 3: Type the 6-digit code

Type the 6-digit number the app shows for Useroam into the Authenticator uygulamasındaki 6 haneli kod (6-digit code from the Authenticator app) box. The form submits by itself as soon as you type the 6th digit; you can also press Doğrula ve Aktif Et (Verify and Activate). The code changes every 30 seconds; if it is about to expire, wait for the next one.

If the code is correct, 2FA is activated and you continue to Device Selection. Vazgeç ve çıkış (Cancel and sign out) closes the session; setup is asked again next time.

Step by step: later sign-ins

Step 1: Type the code

After e-mail and password, the İki Adımlı Doğrulama (Two-Factor Authentication) screen opens: "Authenticator uygulamasındaki 6 haneli kodu girin" (enter the 6-digit code from the Authenticator app). Type the current code; the form submits on the 6th digit (or press Doğrula, Verify). Çıkış (Sign out) cancels.

Step by step: when you change phones (reset)

If your old phone still works, you can reset 2FA yourself inside the panel.

Step 1: Reset from My Profile, 2FA Management

Click the person icon (My Profile) in the top bar and open the 2FA Management tab. The green box says "Two-factor authentication (Authenticator) is active." Type your password in Current Password (verification), tick the "2FA'yi sifirlamak istedigimi onayliyorum." (I confirm I want to reset 2FA) box and press the red Reset 2FA button. The browser asks "2FA will be reset and setup will be required again. Continue?"; confirm with OK.

Step 2: Complete the setup with the new phone

The setup screen opens immediately. Scan the QR code with the app on your new phone and follow the "first setup" steps above. You can delete the Useroam entry on the old phone; it no longer works.

If you no longer have the old phone: use Forgot Password on the sign-in screen. A new password is e-mailed and 2FA is reset; setup is asked again at sign-in. See Quick Start: Your First Sign-in.

"2FA not set up" warning

If the 2FA Management tab shows the yellow box "Two-factor authentication is not set up.", you also see "Set up an Authenticator app (Google / Microsoft) to protect your account." and a Set Up 2FA button.

The easiest fix is to sign out with the icon at the top right and sign in again; after the password the setup screen opens by itself. (The Set Up 2FA button currently sends a signed-in user to the sign-in screen; this is a known issue.)

Every field and button

Field / Button	Where	What it does
QR code	Setup screen	Adds your account to the verification app.
Manuel kurulum kodu (manual setup key)	Setup screen	Key to type into the app if you cannot scan.
Hesap / Yayıncı (Account / Issuer)	Setup screen	Name shown in the app (your e-mail) and issuer (Useroam).
6-digit code box	Setup screen	Current code from the app. Submits on the 6th digit.
Doğrula ve Aktif Et (Verify and Activate)	Setup screen	Checks the code, turns on 2FA and completes sign-in.
Vazgeç ve çıkış (Cancel and sign out)	Setup screen	Closes the session.
Code box and Doğrula (Verify)	Sign-in code screen	Checks the current code on every sign-in.
Çıkış (Sign out)	Sign-in code screen	Cancels the sign-in.
Current Password (verification)	My Profile, 2FA Management	Confirms that you are the one resetting.
Confirmation box	My Profile, 2FA Management	Prevents accidental reset; the button does not work without it.
Reset 2FA	My Profile, 2FA Management	Deletes the old setup and opens a new setup right away.
Set Up 2FA	My Profile, 2FA Management (when not set up)	Intended to open the setup screen; see the note above.

Warnings and errors

Message	Meaning	What to do
6 haneli sayı girin. (Enter a 6-digit number.)	Fewer than 6 digits, or letters.	Type the 6 digits without spaces.
Kod doğrulanamadı. Authenticator uygulamanızdaki güncel kodu deneyin. (Code could not be verified. Try the current code.)	Wrong or expired code during setup.	Wait for a new code. Make sure the phone clock is automatic.
Kod doğrulanamadı. (Code could not be verified.)	Wrong or expired code at sign-in.	Type the current code. If the app has several Useroam entries, use the newest one.
Oturum doğrulaması başarısız. Sayfayı yenileyip tekrar deneyin. (Session check failed.)	The page stayed open too long.	Refresh the page.
Kayıt sırasında hata oluştu. Tekrar deneyin. (An error occurred while saving.)	The setup could not be saved.	Try again; contact support if it continues.
(You are sent back to the sign-in screen)	More than 10 wrong codes in one sign-in; the session is closed for security.	Sign in again and check the phone clock.
Your current password is incorrect.	Wrong password when resetting.	Type your panel password correctly.
2FA has been reset. Scan the new QR code to set it up again.	Reset succeeded.	Scan the new QR code.
2FA could not be reset.	A technical error.	Try again.

Frequently asked questions

Can I turn 2FA off? No. It is mandatory for all panel users.

Can I receive the code by SMS? No. Panel sign-in works only with a verification app, which is safer than SMS and works offline.

Can I set up the same account on two phones? Yes. Scan the same QR code with both phones during setup and both will produce the same code. To add a second phone later, reset and scan with both.

Does every administrator set up their own 2FA? Yes. 2FA is personal. Do not share your account; create a separate user in Administrators.

Codes are always rejected. Set your phone's date and time to automatic and delete old Useroam entries in the app.

Related pages

• Quick Start: Your First Sign-in
• My Profile (Account Info)
• Administrators

Agreement Approval

Before you start using Useroam Cloud you must approve two agreements on behalf of your business: the SaaS Customer Agreement and the Useroam Data Processing Agreement (DPA). The approval screen opens by itself in the panel; this page explains it step by step.

Note: the agreement texts and some labels on this screen are currently Turkish only, even with the English panel. Turkish labels are given with their meaning in parentheses.

What is it for?

It puts the scope of the service and how guest data is processed (KVKK, the Turkish data protection law) in writing. Your approval is recorded with the date, agreement version and a fingerprint (hash) proving the document was not changed; no wet signature is needed.

When do I use it?

• The first time someone from your account signs in and selects a device.
• When Useroam publishes a new version of the agreements (only the new version is asked).

Before you start

• Approval is per account: one person from your business is enough. Until then, every administrator of the account sees this screen instead of the panel.
• Your name and username are recorded as the approver. The person authorised to sign for the business should approve.
• Have your legal company title and full address ready (asked if missing).
• Dealer accounts and Useroam staff do not see this screen.

Step by step

Step 1: Complete your company details (only if missing)

If your account has no company title or address, Complete your company details opens first. The blue box shows your company and your name.

• Company / Legal Title *: the official name written in the agreement, e.g. ABC Tourism and Hotel Management Ltd. (at least 3 characters).
• Merkez Adresi * (Head office address): street, number, district/city. At least 10 characters.
• KEP Adresi (opsiyonel) (registered e-mail address, optional): Turkish registered electronic mail address if you have one, e.g. ornek@hs01.kep.tr.

Press Save and continue to the agreements. The details are saved to your account and filled into the agreement text (highlighted in yellow).

Step 2: Read the first agreement to the end

On Approve the service agreements each agreement is in its own card, with its name and version (Version 2.3, for example) at the top. Scroll inside the text box all the way down. Below the box: "The confirmation box becomes active once you scroll the document to the end." The box cannot be ticked before that.

To keep a copy or send it to your legal team, use PDF olarak indir (Download as PDF) at the top right of the card.

Step 3: Tick the confirmation box

At the end of the text the note disappears and the box "Bu sözleşmeyi (...) okudum, anladım ve onaylıyorum." (I have read, understood and approve this agreement) becomes active. Tick it.

Step 4: Repeat for the second agreement and approve

Do the same in the Useroam Veri İşleme Sözleşmesi (DPA) card. When both boxes are ticked, the Okudum, tüm sözleşmeleri onaylıyorum (I have read and approve all agreements) button at the bottom turns blue; press it.

The Dashboard then opens. The footer note says: "Your approval is recorded together with the date, version and document integrity hash."

Every field and button

Field / Button	What it does	Example
Company / Legal Title *	Official name of the customer party.	ABC Tourism Ltd.
Merkez Adresi * (Head office address)	Customer address in the agreement.	Liman Cad. No:5 Kemer/Antalya
KEP Adresi (opsiyonel)	Official notification address.	ornek@hs01.kep.tr
Save and continue to the agreements	Saves company details and opens the agreements.
Blue info box	Company name and "Onaylayan" (approver) with name and username.
Version	Version of the agreement you approve.	2.3
PDF olarak indir (Download as PDF)	Opens the PDF in a new tab.
Confirmation box	Declares you read that agreement. Active after scrolling to the end.
Okudum, tüm sözleşmeleri onaylıyorum	Records the approval if all boxes are ticked and opens the panel.
Sign out (top right)	Leaves without approving. The screen appears again next time.

Warnings and errors

Message	What to do
Please enter your company title and full address completely.	Title at least 3, address at least 10 characters.
To continue you must read each agreement and tick its confirmation box.	Scroll both agreements to the end and tick both boxes.
Your session has expired, please refresh the page.	Refresh and approve again.
The document could not be loaded.	Refresh; contact support if it continues.

Frequently asked questions

Can I use the panel without approving? No. Every panel page redirects to this screen until approval. The Useroam Go staff app is not affected; your staff keep working.

The box will not tick. Scroll the text to the very bottom with the card's own scroll bar; scrolling the page itself is not enough.

I typed the wrong company address. After Save and continue to the agreements, company details cannot be changed on this screen. Contact Useroam support or your dealer.

Where can I see the agreement later? Keep the copy you get with PDF olarak indir; you can also ask Useroam.

Related pages

• Quick Start: Your First Sign-in
• Device Selection
• Dashboard (Home Screen)

Device Selection

Device Selection is the screen where, after signing in, you choose which business (which device) to open. In Useroam every branch or guest Wi-Fi network is a device: the firewall or router guests connect through (Sophos, FortiGate, MikroTik and so on). Every panel screen works on the device you select.

What is it for?

If you have several branches or devices, it lets you switch between them. Each device's licence status, IP address and type are shown here. Adding a new device also starts here.

When do I use it?

• After every sign-in (it opens by itself after two-factor authentication).
• To look at another branch while inside the panel: click the computer icon at the far right of the top bar (Device Selection).
• When adding a new branch or firewall.

Before you start

• Only devices you are authorised for are listed. If you cannot see a device, ask your account administrator for access (Administrators).
• If you came from the dealer panel to a customer, a box at the top says "... müşterisinin cihazları görüntüleniyor (redirected from dealer panel)" (this customer's devices are shown) with a Bayi Paneli (Dealer Panel) back button.

Step by step

Step 1: Click the card of the device to open

The screen opens in Kart (Card) view. Each card shows the device name at the top, the company name under it, a computer icon with the IP address in the middle and the device type under Firewall: at the bottom. A green icon means the licence is valid, red means it has expired. Click anywhere on the card to open that device's Dashboard.

Step 2 (optional): Switch to list view

With many devices, use Liste (List) at the top right. Your choice is remembered in your browser. Columns: Device (clickable name), Company, IP, Firewall, License Expiry, Status (green Active or red Expired badge) and Action (arrow button that opens the device). Click a column header to sort; the number box at the top left sets rows per page (10, 25, 50, 100, All). Below the table there is a counter such as "Total: 2 / 1 - 2" and page buttons.

Step 3 (optional): Search for a device

Type part of a device name, company, IP, firewall type or date in Search.... The list narrows as you type; Turkish characters and upper/lower case do not matter.

If nothing matches you see "No results found. Try a different keyword." Clear the search to see all devices again.

Step 4 (optional): Add a new device

New Device at the top right opens the new device screen. Steps: Adding a New Device.

Every field and button

Field / Button	What it does	Example
Search...	Filters devices by name, company, IP, firewall type.	kemer
Kart (Card)	Card view (24 cards per page).
Liste (List)	Table view.
New Device	Opens the new device screen.
Device card	Name, company, IP, Firewall: type. Click to open.	Useroam Demo, Sophos
Icon colour	Green: licence valid. Red: licence expired.
Previous / Next	Page through cards. "1 / 1" shows the page; a counter such as "2 sonuç • 1–2" (2 results) is on the left.
Device, Company, IP, Firewall	List columns.
License Expiry	Last day of the licence.	31-12-2026
Status	Active or Expired.
Action	Arrow button opens the device.
Rows per page box	10, 25, 50, 100, All.	25
Total	Number of devices and the range shown.	Total: 2 / 1 - 2

Warnings and empty states

Message	Meaning	What to do
No results found. Try a different keyword.	Nothing matches the search, or there are no devices at all.	Clear the search. If there are no devices, add one with New Device.
No Record	No rows to show in list view.	Clear the search.
No device found that you are authorized for	(From the dealer panel) you have no access to this customer's devices.	Ask your dealer administrator; return with Bayi Paneline Dön.
No device matches your search.	(From the dealer panel) nothing matches.	Change the search.
Red icon / Expired badge	The device licence has expired; guest sign-ins stop.	Contact your sales representative or dealer (License Information).

Frequently asked questions

I have only one device. Do I see this screen every time? Yes; it always opens after sign-in. Click your card once.

How do I switch to another branch? Click the computer icon at the far right of the top bar (Device Selection) and pick the other card.

A device is missing. You may not have access to it. Ask your account's main administrator.

Why is the IP address shown? It is the address the device uses on the internet; Useroam recognises the device by it. If it changed, update it in Device Settings.

Kart/Liste are in Turkish in the English panel. These two buttons and the card counter are currently Turkish only.

Related pages

• Adding a New Device
• Device Settings
• Dashboard (Home Screen)
• Quick Start: Your First Sign-in

Panel Layout: Side Menu, Top Bar and Language

Every panel screen has the same two bars: at the top the language, full screen, profile, sign-out and device selection icons; on the left the menu leading to every screen. This page explains where each menu is, which package shows it and how to change the panel language.

What is it for?

It helps you find the screen you need quickly and understand why a menu item may be missing.

When do I use it?

• When you start using the panel and want to learn the menu.
• When a colleague says "go to that menu" and you cannot find it.
• When you want to use the panel in English (or back in Turkish).

Top bar

Icon (left to right)	Name (on hover)	What it does
Three lines (far left)		Hides or shows the side menu. On a phone this opens the menu.
USEROAM logo		Returns to the Dashboard.
Language icon (A and 文)	Language	Opens Türkçe / English. See the steps below.
Four corners	Full Screen	Makes the panel full screen (wide screens only). Press Esc to exit.
Person	My Profile	Your details, password, 2FA and API keys: My Profile.
Arrow leaving a door	Log Out	Closes the session and returns to the sign-in screen.
Computer (far right)	Device Selection	Opens Device Selection to switch branch/device.

The blue strip at the bottom of each page has Help (this help site), Terms and Privacy links.

Step by step: changing the panel language

Step 1: Click the language icon

Click the language icon, the first of the icons on the right. The small menu shows a tick next to the current language.

Step 2: Choose English or Türkçe

Click the language you want. The same page reloads in the new language. Your choice is saved to your profile and applies to later sign-ins too (even if you pick another language on the sign-in screen).

The same setting is the Panel Language box in My Profile. The Language box on the sign-in screen applies only if no language is saved in your profile.

Note: in the English panel some screens and fields (2FA screens, Forgot Password, agreement texts, some descriptions) are still Turkish. Names that come from your own data (menus, departments, request types) stay in the language you typed them.

Side menu map

The menu starts with the Menu heading. Click a main heading (Bumerang, Guests, Captive Portal, Analytics and Reports, Settings) to open its submenu; click again to close. The current page is highlighted and its group stays open. The images come from the demo account (all modules on); your menu may be shorter depending on your package.

Bumerang open (Campaign, Engagement, Audience & AI, Business, Analytics sections):

Guests and Captive Portal open:

Analytics and Reports and Settings open:

Menu	Section	What is inside	Help page	When it is shown
Dashboard		Live summary of your business: connected guests, visits, 5651 logs and licence status.	Dashboard	Hidden for module-restricted users.
MikroTik Management		Console to manage your MikroTik device from the panel.	MikroTik Management	Only when the selected device is MikroTik.
Bumerang	Campaign	Campaigns, Bulk Send, Send Schedule: automatic or bulk SMS/WhatsApp messages to guests.	Campaigns, Bulk Sending, Sending Calendar	With the marketing (Bumerang) package.
Bumerang	Engagement	Surveys and Ads shown at Wi-Fi sign-in.	Surveys, Advertisements	With the marketing package.
Bumerang	Audience & AI	Opted-in Guests (guests who gave marketing consent) and Useroam AI · Autopilot (AI suggestions).	Opted-in Guests, Autopilot	With the marketing package.
Bumerang	Business	Events, Treasure Hunt; depending on your business type Restaurant (Menus, Requests, Board, Request Types, Settings), Hotel (Guest Portal, Portal Design, Request Management, Request Monitor, Hotel report, Room Board, Speed Package Sales, Bookings & Extras, PMS Integration, SLA Rules, Notifications, Lost & Found, Studio), Retail (Store & QR Signup, Coupon & Wheel, Checkout / Verify Coupon, Request Monitor, Segments, Reports, Automation, Store Texts, Studio); also Staff, Operations, Automation, Module Permissions.	Events, Treasure Hunt, Restaurant Requests, Menus, Hotel Guest Portal, Hotel Request Management, Retail, Staff, Operations, Automation, Module Permissions	With the marketing package and only if the module is installed (modules switched on in Module Permissions).
Bumerang	Analytics	Summary, Guest 360°, Live Radar (with a LIVE badge), Reports.	Summary, Guest 360°, Live Radar, Bumerang Reports	With the marketing package.
Guests		Active Guests, SMS/Whatsapp, Blocked Users, Hotel Guests, Local Users, Pending Approval, Groups, Coupon Codes, Bulk Users, New User: guests using the Wi-Fi and their accounts.	Active Guests, SMS / WhatsApp Users, New User	Hidden with the 5651-log-only package and for module-restricted users.
Captive Portal		Portal Settings, SMS Portal Settings, WhatsApp Portal, Portal Language Settings: the sign-in page guests see when joining the Wi-Fi.	Portal Settings, SMS Portal, WhatsApp Portal, Portal Language Settings	Hidden with the 5651-log-only package and for module-restricted users.
Analytics and Reports		Visit Analytics, Device Reports, 5651 Logs, Audit Log, SMS/Whatsapp Reports, Local User Report.	Visit Analytics, 5651 Logs, Audit Log, SMS / WhatsApp Reports, Local User Report; Device Reports (help page in preparation)	5651 Logs, Audit Log and Device Reports in every package; the others are hidden with the 5651-log-only package. Never shown to module-restricted users.
Staff WiFi		A separate, password-free, certificate-based Wi-Fi for your employees.	Staff Wi-Fi Administration	Administrator (admin) users only; hidden for module-restricted users.
Settings		Hotspot QR Code, Excluded Users, Notifications, Device Settings, Administrators, Admin Profiles, SMS Settings, WhatsApp Settings, License Information.	Hotspot QR Code, Notifications, Device Settings, Administrators, Administrator Profiles, SMS Settings, WhatsApp Settings, License Information; Excluded Users (help page in preparation)	Hidden for module-restricted users. Excluded Users only if that module is on.

Why can't I see a menu item?

• Your package: without the marketing (Bumerang) package, Bumerang is a single line; clicking it opens a page introducing Bumerang and starting a free 10-day discovery demo. With the 5651-log-only package, Guests, Captive Portal, Visit Analytics, SMS/Whatsapp Reports and Local User Report are hidden. See your package in License Information.
• Module not installed: Restaurant, Hotel, Retail, Events, Treasure Hunt and other business modules appear only when installed and not switched off in Module Permissions.
• Restricted user: if the main administrator limited you to certain modules (Module Permissions), only those modules appear under Bumerang; Dashboard, Guests, Captive Portal, Analytics and Reports, Staff WiFi and Settings are hidden.
• Device type: MikroTik Management appears only when the selected device is MikroTik.
• Not an administrator: Staff WiFi and Module Permissions are shown only to administrator (admin) users.

Frequently asked questions

The menu is not visible on my phone. Tap the three-line button at the top left; the menu slides in from the left.

I changed the language but it went back next time. The top-bar language menu saves the choice to your profile. If it went back, check Panel Language in My Profile.

It says Restaurant instead of Hotel. The business menu name follows the installed module; if both are installed, both appear.

Which menu is for the job I want? See What Do I Want To Do? Which Page?.

Related pages

• Dashboard (Home Screen)
• My Profile (Account Info)
• Module Permissions
• What Do I Want To Do? Which Page?

Dashboard (Home Screen)

The Dashboard is the home screen that opens when you select a device. It shows the live state of the selected business (device), the last 30 days of visits, Bumerang marketing results and 5651 log health on one page. You do not change anything here; you look and jump to the related screen.

What is it for?

At the start of the day it answers at a glance: "Is the Wi-Fi working, how many guests came today, are logs being recorded, when does my licence end?"

When do I use it?

• On every sign-in (it opens after device selection), and via Dashboard in the side menu or the USEROAM logo at the top.
• To check for a sudden drop in guests.
• To see that the 5651 log stream and signing are healthy.

Before you start

• Data belongs to the device you selected. For another branch, switch in Device Selection.
• Sections depend on your package: Bumerang sections only with the marketing package; visit and guest charts not with the 5651-log-only package. People on the Excluded Users list (your staff) are not counted.

Step by step: reading the screen top to bottom

Step 1: Top card (live view)

At the top: the device name, today's date and "Live view of your business". At the top right a blinking green dot and "Live, refreshes every 20 sec": the first two numbers update every 20 seconds without reloading.

• Guests online now: guests with an open Wi-Fi session right now.
• Sessions today: sessions opened since midnight.
• Unique guests this week: different guests in the last 7 days.
• Stay duration: typical (median) session length in the last 30 days, shown as sec, min or "1h 20m".

Step 2: Useroam AI · Autopilot band (marketing package)

The badge on the left shows the state: ACTIVE · semi-automatic, ACTIVE · fully automatic or OFF. When active, the big number is "suggestions awaiting approval". The middle lists the last 6 activities with a Pending approval (yellow) or Done (green) badge. The green button reads Review suggestions, Go to Autopilot or Turn on Autopilot and opens Autopilot.

When off, an intro text appears: "Monitors your business 24/7, spots opportunities and drafts campaigns; you just approve." With no activity: "No activity yet. Autopilot will analyze your business on its first run." (Activity titles come from the data and may be Turkish.)

Step 3: Bumerang counters (last 30 days)

Five coloured boxes: Active campaigns, Sends · 30d, Clicks · 30d, Returning guests (with a percentage) and Net revenue · 30d (in TL if an average bill was entered in campaigns, otherwise a dash).

Step 4: Bumerang cycle and top campaigns

The Bumerang cycle card shows "From send to return, last 30 days" in three bars: Sent, Clicked, Returned, followed by "Out of every 100 sends, X brought a guest back to your business." Command center opens Summary.

Top campaigns ("Last 30 days, by returns") lists the 3 campaigns that brought most guests back, with sends and a returns badge. With no sends: "No sends in this period."

Step 5: Visit trend and New / Returning guests

The Visit trend chart shows Visitors (blue area) and Sessions (green dashed line) for each of the last 30 days; the subtitle gives the total. The New / Returning guests ring compares first-time and repeat guests ("X% of your guests come back"). Detailed analytics opens Visit Analytics.

Step 6: Heatmap and last connections

The Hour × day heatmap shows weekdays (Mon to Sun) against hours (0-23); the darker the square, the more sessions started then. Hover for the exact number. The subtitle says "Your busiest time:" (e.g. Fri 20:00). Handy for staff planning.

Last 5 Connections lists the 5 most recent guests with a sign-in type icon (refreshes every 2 minutes). All Connections opens All Connections. (Guest details are hidden in the image.)

Step 7: Guest profile, cities and signup channel

• Guest profile: registered guests and the Male / Female / Not specified split.
• Where do they come from?: "Top 5 cities of registered guests" as bars. Without data: "No city data yet."
• Signup channel: "How guests sign in": guests registered via SMS and WhatsApp.

Step 8: System health (5651, licence, device)

• 5651 live log stream: chart of log volume from the device, updated every 5 seconds. The subtitle gives the state: "Log stream healthy · Uptime 100%", "Log stream interrupted (X sec)" (red) or "Could not fetch log data" (red). While loading it says "connecting…".
• 5651 signing: Waiting (size of logs not yet signed), Signed / Stamped (size of archived logs), the To be signed bar (percentage of 10 GB; yellow at 60%, red at 90%) and Next Signing ("26 min", "Calculating..." or "In the next round"). Logs are time-stamped every night and whenever 10 GB fills up.
• License: Active (green), "X days left" (yellow at 30 days or less) or Expired (red), with the end date.
• Device: device type (Sophos, MikroTik...) and IP address.

The demo device in the image sends no real logs, so it reads "Could not fetch log data"; with logs flowing you see the green "Log stream healthy".

Boxes that appear in special cases

Box / Message	When	What to do
License expired! "Your license expired on [date], user logins have been stopped automatically..." (red box at the top)	The licence end date has passed and the licence is inactive.	Contact your sales representative or dealer. Guests cannot sign in meanwhile.
Accounting setup guide for your device (orange-headed card, currently Turkish only)	No session record has come from this device in the last 90 days. Instead of charts you see steps for turning on RADIUS accounting for your brand (FortiGate, Sophos, MikroTik, Palo Alto...).	Apply the steps on your device or pass them to your installer. Charts appear once data arrives.
Purple intro card: "{X} guests visited in the last 30 days." or "Are your guests coming back?"	You do not have the marketing (Bumerang) package.	Start the 10-Day Demo opens a free discovery demo ("sending unlocks with purchase"). If the demo was already used, I'm interested, call me leaves a request for sales; then "Request received" is shown.
"Request received, our sales team will contact you shortly." (green)	After I'm interested, call me.	Nothing to do.
Stay duration shows a single dash	5651-log-only package.	Normal.

Frequently asked questions

"Guests online now" looks higher than reality. Some devices do not send "session ended" when a guest leaves, so such sessions may count as open for a while. See the live list in Active Guests.

The charts are empty. If no session data comes from your device, the accounting setup guide appears; follow it. On a new device data takes a few days to build up.

Are my staff counted? People you add to Settings, Excluded Users are not counted on the Dashboard.

It says the log stream is interrupted. No logs have come from the device for a while. Check that it is on and online; contact Useroam support if it continues. 5651 logging is a legal requirement in Turkey.

Another branch's Dashboard? Use the Device Selection icon in the top bar.

Related pages

• Panel Layout: Side Menu, Top Bar and Language
• Visit Analytics
• 5651 Logs
• Bumerang Summary
• License Information

What Do I Want To Do? Which Page?

Find the job you want to do in the tables below: the second column says which menu to open in the panel, the third links to the help page explaining it step by step. Menu paths are written as "Main menu, submenu".

What is it for?

It takes you straight to the job without knowing which screen to open.

When do I use it?

• When you are new to the panel.
• When you think "where did I do this in the panel?".

If a menu item is missing, it may be hidden by your package or permissions: see "Why can't I see a menu item?" on Panel Layout: Side Menu, Top Bar and Language.

Getting started

What do I want to do?	Where in the panel?	Help page
Sign in for the first time, forgot my password	Sign-in screen	Quick Start: Your First Sign-in
I changed phones and cannot generate a code	My Profile, 2FA Management	Two-Factor Authentication (2FA)
Change my password, name, e-mail or mobile number	Top bar, person icon	My Profile
Use the panel in English	Top bar, language icon	Panel Layout
Switch to another branch (device)	Top bar, computer icon	Device Selection
Add a new branch / firewall	Device Selection, New Device	Adding a New Device
Get past the agreement approval screen	Opens by itself	Agreement Approval

Setup wizards and step-by-step tasks

What you want to do	Page
Set up your restaurant or hotel in the panel	Venue Setup Wizard
Add a new device (firewall, MikroTik) to the panel	Adding a New Device
Set up a Sophos device automatically over the API	Sophos Firewall API Setup
Set up a MikroTik device from the panel	MikroTik Setup Wizard
Set up a MikroTik device without opening it to the internet	Offline setup (without opening to the internet)
Open a VPN on MikroTik	VPN (WireGuard) Setup
Get your restaurant running on day one	Setting up your restaurant on day one
Get your hotel running on day one	Setting up your hotel on day one
Prepare a QR menu and put it on the tables	Setting up a QR menu from start to finish
Set up in-store QR sign-up and the coupon wheel	Setting up store QR sign-up and the coupon wheel
Send your first campaign to guests	Creating my first campaign
Prepare a survey	Creating a survey
Set up the Wi-Fi login screen guests see	Setting up the guest Wi-Fi login screen for the first time

Guest Wi-Fi sign-in

What do I want to do?	Where in the panel?	Help page
Set up the page guests see when joining the Wi-Fi (logo, text, colours, KVKK)	Captive Portal, Portal Settings	Portal Settings
Set up sign-in by SMS	Captive Portal, SMS Portal Settings	SMS Portal Settings
Set up sign-in by WhatsApp	Captive Portal, WhatsApp Portal	WhatsApp Portal Settings
Edit the languages of the sign-in page	Captive Portal, Portal Language Settings	Portal Language Settings
Print a Wi-Fi QR code for tables	Settings, Hotspot QR Code	Hotspot QR Code
Limit internet speed or time per group	Guests, Groups	Groups

Guests

What do I want to do?	Where in the panel?	Help page
See who is connected right now	Guests, Active Guests	Active Guests
See guests who registered via SMS/WhatsApp	Guests, SMS/Whatsapp	SMS / WhatsApp Users
Block a guest	Guests, Blocked Users	Blocked Users
Add a person who signs in with username and password	Guests, New User	New User
Create many users or coupon codes at once	Guests, Bulk Users / Coupon Codes	Bulk Users, Coupon Codes
Approve pending guests	Guests, Pending Approval	Pending Approval

Reports and legal logging

What do I want to do?	Where in the panel?	Help page
View and download 5651 log records	Analytics and Reports, 5651 Logs	5651 Logs
See who did what in the panel	Analytics and Reports, Audit Log	Audit Log
See how many guests came and how long they stayed	Dashboard, Visit Analytics	Dashboard, Visit Analytics
See the SMS/WhatsApp messages sent	Analytics and Reports, SMS/Whatsapp Reports	SMS / WhatsApp Reports

Marketing (Bumerang)

What do I want to do?	Where in the panel?	Help page
Send automatic welcome / win-back messages	Bumerang, Campaigns	Campaigns
Send a one-off announcement to all guests	Bumerang, Bulk Send	Bulk Sending
Run a guest survey	Bumerang, Surveys	Surveys
Show ads on the sign-in page	Bumerang, Ads	Advertisements
Approve campaigns suggested by AI	Bumerang, Useroam AI · Autopilot	Autopilot
Prepare an event page	Bumerang, Events	Events

Business modules

What do I want to do?	Where in the panel?	Help page
Create a QR menu	Bumerang, Restaurant, Menus	Online Menu
Manage restaurant requests and tasks	Bumerang, Restaurant	Requests, Operations
Manage the hotel guest portal and room requests	Bumerang, Hotel	Guest Portal, Request Management
Add staff (Useroam Go app)	Bumerang, Staff	Staff
Choose which modules are on and who sees what	Bumerang, Module Permissions	Module Permissions

Account and settings

What do I want to do?	Where in the panel?	Help page
Add another administrator	Settings, Administrators	Administrators
Change device name, IP address, 5651 setting	Settings, Device Settings	Device Settings
See my licence end date	Settings, License Information	License Information
Set up e-mail / SMS alerts	Settings, Notifications	Notifications
Give employees a separate password-free Wi-Fi	Staff WiFi	Staff Wi-Fi Administration
Connect other software to the panel (API)	My Profile, API Keys	API Keys
Manage my MikroTik device	MikroTik Management	MikroTik Management

Frequently asked questions

The job I want is not in the table. Type a word in the search box at the top of this help site (e.g. "coupon", "speed"). If you cannot find it, contact Useroam support.

My menu path looks different. The business menu is called Restaurant or Hotel depending on the installed module; some menus are hidden depending on your package.

Related pages

• Quick Start: Your First Sign-in
• Panel Layout: Side Menu, Top Bar and Language

My Profile (Account Info)

My Profile is where the signed-in person manages their own account: name, e-mail, panel language, mobile number, password, two-factor authentication and API keys. To add or edit other administrators use Administrators.

Note: in the English panel the page title (Profilim), the Bilgilerim (My Details) tab and some field labels are still Turkish; they are given with their meaning in parentheses.

What is it for?

It makes sure notifications reach the right address, lets you choose your own password and set up sign-in again when you change phones.

When do I use it?

• After your first sign-in, to check your name, e-mail and mobile number.
• To replace the password you received by e-mail with your own.
• To reset 2FA when you change phones.
• When you decide to use the panel in English.

Before you start

Click the person icon in the top bar (hover text My Profile). The subtitle says "Manage your account details, password and 2FA settings here."; the Dashboard link returns to the home screen. There are four tabs: Bilgilerim (My Details), Change Password, 2FA Management, API Keys.

Step by step

Step 1: Fill in My Details and save

The Bilgilerim tab is open. First Name and Last Name are required. E-Mail is the "Address where notifications will be sent." Choose Türkçe or English in Panel Language ("Applies immediately and on every sign-in."). Username (Sign-in) is grey and locked: "Your panel sign-in address. Cannot be changed." Save with Save; a green "Account details updated." appears.

Company Address ("Used as the contracting party address in agreements.") and KEP Adresi (registered e-mail address, optional) show your account's agreement details. Important: these two fields are currently not saved from My Profile (known issue). For an address or KEP change, contact Useroam support or your dealer. Details entered on the agreement screen at first sign-in are saved.

Step 2: Verify your mobile number

Type your number in Cep Telefonu (Mobile Phone), e.g. 0532 123 45 67, and press Verify next to it. The number is used for SMS notifications from the panel and is optional. Under the box you see "Mobile phone for SMS notifications (optional). Enter a number and save it with "Verify"." or, when verified, a green tick with "Verified number: ...".

Step 3: Type the code from the SMS

The Cep Telefonu Doğrulama (Mobile Phone Verification) window opens, saying a 6-digit code was sent to the number, and "The SMS may take 1-2 minutes to arrive." Type the code in Verification Code and press Verify and Save (or Enter). After "Doğrulandı. Sayfa yenileniyor..." (Verified, reloading) the number is saved. If no SMS comes, press Resend (you must wait 60 seconds before the next try). Cancel closes the window without saving.

Step 4: Change your password

Open Change Password. Type Current Password, New Password (at least 8 characters) and New Password (Repeat), then press Update Password. On success: "Your password has been updated." You stay signed in; use the new password next time.

Step 5: Reset 2FA if needed

2FA Management shows the 2FA status. If you changed phones, type Current Password (verification), tick the confirmation box and press Reset 2FA; the new setup screen opens at once. Full details: Two-Factor Authentication (2FA).

Step 6: API keys (only for integrations)

The API Keys tab creates keys so other software can connect to your panel data. Most businesses do not need it. Details: API Keys.

Every field and button

Field / Button	What it does	Example
First Name, Last Name	Your name in the panel and records. Required.	Ayşe, Yılmaz
E-Mail	Notification address. May be empty; if filled, must be valid.	ayse@mybusiness.com
Panel Language	Panel language; applies right after saving.	Türkçe / English
Company Address, KEP Adresi	Show the company details in your agreement (not saved from here at the moment).
Cep Telefonu (Mobile Phone) + Verify	Verifies and saves your number with an SMS code.	0532 123 45 67
Username (Sign-in)	Your sign-in name. Cannot be changed.
Save	Saves the My Details tab.
Verification Code, Resend, Cancel, Verify and Save	Fields and buttons of the phone verification window.	482913
Current Password, New Password (at least 8 characters), New Password (Repeat), Update Password	Password change.
Current Password (verification), confirmation box, Reset 2FA, Set Up 2FA	2FA management.

Warnings and errors

Message	What to do
Account details updated.	Saved.
Ad zorunludur. / Soyad zorunludur. (First/last name is required.)	Fill in both names.
Enter a valid e-mail address.	Use the name@domain.com form.
An error occurred while updating.	Try again.
Önce cep telefonu girin. (Enter a mobile number first.)	Type the number, then press Verify.
Bu numara zaten doğrulanmış... (This number is already verified.)	No need to verify the same number again.
Geçerli bir cep telefonu girin. (Enter a valid mobile number.)	Use only digits, spaces, +, - and brackets.
6 haneli kodu girin. / Doğrulama kodu 6 haneli olmalıdır. (Enter the 6-digit code.)	Type the 6 digits from the SMS.
Doğrulama kodu hatalı. (Wrong code.)	Use the code from the latest SMS.
Doğrulama kodu bulunamadı. Lütfen yeni kod isteyin. (No code found, request a new one.)	Press Resend.
Yeni kod gönderildi. / Yeniden gönderilemedi. (New code sent / could not resend.)	Wait for the SMS / try again later.
Kod gönderilemedi. / SMS gönderimi kuyruğa alınamadı. / OTP kaydedilemedi. (Code could not be sent.)	Try again in a few minutes; contact support if it continues.
Güncelleme başarısız. / Doğrulama başarısız. / Bağlantı hatası (Update failed / Verification failed / Connection error)	Check your connection and try again.
Your current password is incorrect.	Type your current panel password correctly.
New password and confirmation do not match.	Type the same password in both boxes.
New password cannot be the same as the current one.	Choose a different password.
Yeni sifre en az 8 karakter olmali. (At least 8 characters.)	Choose a password of 8 characters or more.
Your password has been updated. / Password could not be updated.	Done / try again.
Session validation failed. Refresh the page and try again.	Refresh the page.

Frequently asked questions

Can I change my username (sign-in e-mail)? Not here. The main administrator can create a new user (Administrators).

I changed E-Mail; did my sign-in change? No. E-Mail is only the notification address; you always sign in with Username (Sign-in).

The verification SMS did not arrive. Wait 1-2 minutes, check the number, then press Resend.

I cannot change my company address. Correct; these fields are not saved from My Profile at the moment. Contact support.

Can I change another administrator's password here? No. My Profile is only for your own account.

Related pages

• Two-Factor Authentication (2FA)
• API Keys
• Administrators
• Panel Layout: Side Menu, Top Bar and Language

API Keys

API Keys is where you create keys that let another piece of software (an automation tool, your own app, a reporting or CRM system) connect to the Useroam panel securely. Keys are on the API Keys tab of My Profile.

What is it for?

With a key, software can pull almost every report you see in the panel: 5651 signed logs, hotspot usage (connected guests, unique visitors, busy hours), Bumerang campaign results, survey answers, QR menu orders, hotel requests, task/maintenance/stock reports, event attendance and retail reports.

Every key is bound to a single device. The key sees the data of the device that was selected in the panel when it was created; it cannot reach another device or another customer's data. If you have several devices, create a separate key for each.

When to use it

• Your IT team wants to pull 5651 logs into its own archive automatically.
• You want reports in your own reporting tool (Power BI, Excel, Google Sheets).
• You are connecting an automation tool such as n8n or Zapier.
• An integrator or developer asks you for an "API key".

If you have no such need, you do not have to use this tab.

Before you start

• Select the device at the top of the panel. The key is bound to that device.
• Get the public IP address of the server that will use the key (your developer will give it). Example: 203.0.113.10 or a block of at most 256 addresses such as 203.0.113.0/24.
• Find out which data the software needs; you will allow only that.
• Only users with full rights on the device can create keys. If your rights are restricted, the tab shows "You are not allowed to manage API keys for this device." and the New Key button is disabled; ask your account administrator.

Step by step

Step 1: Open the API Keys tab

Open My Profile with the person icon in the top bar and switch to the API Keys tab. Under the title you see "These keys can only access this device: device name"; check that you are on the right device. If there are no keys yet, "You do not have an API key yet. Use the button above to create one." appears. Click New Key on the right.

Step 2: Fill in label, IP, access and validity, then click Create

• Label *: a name that reminds you what the key is for. Example: Power BI reports, Log archive. Up to 120 characters.
• IP Whitelist *: the IP addresses the key may be used from, one per line (commas also work). A block can be at most /24 (256 addresses); wide blocks such as 0.0.0.0/0 are rejected. Requests from other addresses are refused.
• What can it access? *: tick only what is needed:
  • 5651 signed logs (ticked by default)
  • Hotspot usage: connected guests, unique visitors, busy hours, login success, Excluded Users report
  • Bumerang campaigns, Surveys, QR Menu, Hotel, Operations (restaurant, tasks, maintenance, stock), Events, Retail and coupons
  • Guest list and marketing consents: contains personal data (phone, name, email). Off by default; turn it on only if really needed. While it is off, phone numbers and names in reports are masked (e.g. 5307****73).
• Validity (days): up to 365 days (1 year). The key stops working when it expires.

The yellow box warns that the key is shown only once. Click Create.

Step 3: Copy the key right away

A green New API Key Created box appears at the top. The key starts with usr_. Click Copy and send the key to your developer through a secure channel. When you refresh the page the box disappears and the key is never shown again.

Step 4: Give the documentation link to your developer

The API documentation (all endpoints) link under the title, or the button in the How to use? window, opens the documentation with every endpoint's parameters, required access type and sample responses: panel.useroam.com/api/docs. Requests can be tried there in the browser.

In short:

1. Send the header Authorization: Bearer usr_... with every request.
2. Call GET https://panel.useroam.com/api/v1/devices.php first; the returned nasid (an encrypted text such as OT37I3...) is the nasid parameter for every other request. The device number you see in the panel does not work.
3. List the ready reports with reports.php?nasid=... and run one with reports.php?nasid=...&key=gunluk_ziyaret_trendi&gun=30.

Endpoint	What it returns	Required access
me.php, devices.php	Key info and its device	Any key
reports.php	More than 70 ready reports (each report has its own module)	The report's module
logs.php	5651 signed log list and download links	5651 signed logs
hotspot.php	Usage summary and daily series; Excluded Users report; g=radar returns the panel live Radar screen	Hotspot usage
bumerang.php	Campaigns, results, deliveries; rapor= returns the 12 ready-made panel reports; g=komuta Marketing Command Center; g=misafir360 Guest 360 segments	Bumerang campaigns
anket.php	Surveys, answer distributions, NPS, raw answers	Surveys
menu.php, menu-report.php	Menu analytics, orders, calls, feedback; g=rapor returns the panel Menu Report	QR Menu
otel.php, otel-report.php	Hotel requests, speed package sales; g=rapor returns the panel Hotel Report	Hotel
operasyon.php	Task board, restaurant requests, maintenance, stock; g=rapor returns the panel Operations report	Operations
etkinlik.php	Events, attendance report, attendees	Events
retail-report.php, coupon-redeem.php	Retail report (g=rapor returns the panel Retail report), coupon check and redeem	Retail and coupons
guests.php, consents.php, logout-users.php, delete-users.php	Guest list, marketing consents, logout/deletion requests	Guest list and marketing consents

Important: requests must come from your whitelisted IPs; log download links are valid for 5 minutes; a request to an endpoint the key has no access to returns 403 scope_denied; all API usage is written to the audit log.

Step 5: Revoke unneeded or leaked keys

Click the red cross (Revoke) at the end of an active key's row and confirm. The row moves down with a grey Revoked badge and requests with that key are refused. Every user with full rights on the device can revoke that device's keys, whoever created them.

Key list columns

Column	What it shows
Label	The name you gave.
Key	The first 12 characters of the key. The full key is never shown again.
IP Whitelist	Allowed addresses.
Access	What the key can read (e.g. 5651 signed logs, QR Menu).
Created by	The user who created the key.
Created / Expires	Creation time and last valid day.
Last used	When and from which IP it was last used; a dash if never.
Usage	Total number of requests.
Status	Active (green), Expired (yellow) or Revoked (grey).

The list shows all keys of the currently selected device.

Warnings and error messages

Message	What to do
You are not allowed to manage API keys for this device.	Ask your account administrator to create the key.
Select at least one access type.	Tick at least one box under "What can it access?".
IP whitelist cannot be empty.	Enter at least one IP address.
Invalid IP: ...	Write the address like 203.0.113.10.
Invalid or too wide IP block (at most /24): ...	Write the block as 203.0.113.0/24 or narrower; wider blocks are not accepted for security.
Validity period must be between 1 and 365 days.	Enter a number from 1 to 365.

FAQ

I forgot to copy the key. It cannot be shown again. Revoke the old key and create a new one.

Can one key read several of my devices? No. For security each key is bound to one device; create one key per device.

Phone numbers in reports have asterisks. The key does not have "Guest list and marketing consents". If really needed, create a new key with that access.

Can I get the same reports I see in the panel? Yes. The API uses the same calculation as the panel report, so the results are identical. Bumerang: bumerang.php?rapor=ozet (other types: kampanya, tiklayan, donus, misafir, menu, urun, anket, cagri, otel, izinli, otel_ariza). Hotel: otel.php?g=rapor&r=ozet (tip, personel, oda, sla, gelir). Operations: operasyon.php?g=rapor. QR Menu: menu.php?g=rapor. Marketing Command Center: bumerang.php?g=komuta. Guest 360: bumerang.php?g=misafir360 (segment with sf=sadik for example, page with sy=2; searching by name or phone with q= needs the guest access). Radar: hotspot.php?g=radar. Retail: retail-report.php?g=rapor. The panel filters (date, channel, staff, room and so on) work with the same names. Add &lang=en for English titles. In Bumerang reports phone numbers and names are always masked, as in the panel, even when the guest access is enabled.

Can I extend an expired key? No. Create a new key and replace it in your software.

We moved the device to another account. Keys created for that device stop working automatically; create a new key in the new account.

Related pages

• My Profile (Account Info)
• 5651 Logs
• Audit Log