Plugin configuration

Every plugin is configured differently. Find below more informations regarding the different configuration keys.

Authentication plugins

Ticket

The ticket logon is a standard login with credentials (username and password) or any configured external authentication module (e.g. LDAP, radius, …).

../_images/loginapi_plugins_ticket.png
Configuration Key Since Mandatory Default
ticket-icon 2.0 Yes fa fa-user
Sets the icon for the plugin

PwdOnly

The pwdonly logon is a standard login with a password. It can be created exactly the same way as when using the default logon page of the IACBOX.

Hint

  • The password login has to be activated on the IACBOX.
  • The password login has to be enabled in a ticket template.
  • For further information see our documentation regarding the Password Login
../_images/loginapi_plugins_pwdonly.png
Configuration Key Since Mandatory Default
pwdonly-icon 2.0 Yes fa fa-key
Sets the icon for the plugin

Free

With the free plugin you can take your clients online without any further authentication steps. The plugin supports two different modes:

  • free:
    • available since API version 2
    • linked with Ticket/Templates/Free Logon of the IACBOX
    • no ticket overrides available
  • to:
    • available since version 17.0
    • the template, which you configured in Modules/Interfaces/Login API/Custom Logon Page, will be used
    • ticket overrides available
../_images/loginapi_plugins_free.png
Configuration Key Since Mandatory Default
free-icon 2.0 Yes fa fa-wifi
Sets the icon for the plugin
free-logon-type 17.0 Yes free
Determines if the plugin is using the settings of Free Logon of the IACBOX

Only available with the logon type to

Configuration Key Since Mandatory Default
otc 17.0 No 3600
Time credit in seconds
otl 17.0 No 17
Ticket limit in MB
omi 17.0 No 500
Max idle timeout in seconds
oep 17.0 No 10800
Expiration period in seconds
odl 17.0 No 2048
Max download bandwidth in kBit/s (max value is the total bandwith under System/Network)
oul 17.0 No 1024
Max upload bandwidth in kBit/s (max value is the total bandwith under System/Network)
ode 17.0 No LoginApi Free Plugin take online
Ticket description

PMS

The PMS plugin works the same way as it does on the IACBOX landing page. After the successful authentication you get to a second page to select a ticket.

New in version 17.0: We also support the PMS Himed and ASAj.

Attention

The following configuration keys have to be in sync with your PMS configuration in Modules/Interfaces/PMS:
  • auth-fields
  • name-check
../_images/loginapi_plugins_pms.png
Configuration Key Since Mandatory Default
pms-icon 2.0 Yes fa fa-hotel
Sets the icon for the plugin
auth-fields 2.0 Yes room, name
The fields which are needed for the authentication
name-check 17.0 No full
Changes the label of the name field
show-email 2.0 No false
Shows an email field (create a custom service to further work with the information)
show-building-selection 2.0 No false
Enables the number padding and building mapping
room-nr-padding 2.0 No 0
Number of digits which has to met in the roomnumber
room-nr-type 2.0 No number
Room number only contains digits or is alphanumeric
building-mapping 2.0 No  
Specific Mapping for the room number e.g.: A:Aaaaaaa;B:Bbbbbbb;C:Ccccccc
show-address-person 2.0 No false
Enables the field how to address a person e.g. Mr. or Mrs.
address-person-mapping 2.0 No  
Specific mapping for address of a person

Himed

The Himed plugin works exactly as the PMS Plugin and also has the same configuration keys. Additional it is possible to define a redirect url because Himed allows a flexible redirect url.

Hint

The following placeholder are available:
  • $USERID = UserId of the Himed client
Configuration Key Since Mandatory Default
Same configuration values as the PMS Plugin
himed-redirect-url 17.0 No  
Redirect URL after Himed authentication

Email

The email plugin is linked with the messaging module Email. Therefore the ticket template will be used which is configured in the email settings (Modules -> Interfaces -> Email).

If you want to use the pwdonly login with the email plugin follow the hint.

Hint

  • The password login has to be activated on the IACBOX.
  • The password login has to be enabled in a ticket template.
  • For further information see our documentation for the Password Login

New in version 2.0.

../_images/loginapi_plugins_email.png
Configuration Key Since Mandatory Default
email-icon 2.0 Yes fa fa-envelope
Sets the icon for the plugin
pwd-only 2.0 Yes false
Set to true if you are using a pwd-only template

SMS

The SMS plugin sends credentials to the given phone number via the configured SMS backend. This has to be configured on Modules -> Interfaces -> SMS.

If you want to use the pwdonly login with the sms plugin follow the hint.

Hint

  • The password login has to be activated on the IACBOX.
  • The password login has to be enabled in a ticket template.
  • For further information see our documentation for the Password Login

New in version 17.0.

../_images/loginapi_plugins_sms.png
Configuration Key Since Mandatory Default
sms-icon 17.0 Yes fa fa-mobile
Sets the icon for the plugin
pwd-only 17.0 Yes false
Set to true if you are using a pwd-only template

Social

The social plugin grants a user internet access via login through an external social platform. Currently supported platforms are facebook, twitter and google.

The plugin doesn’t have a connection to the module Social Login of the IAC-BOX and can therefore be used without further licensing.

Attention

You need to add the following parameters to your callback-url in the configuration of the app for a successful login: ?auth=social&hauth.done=<Provider> where provider is one of twitter or google depending on the used platform.

Attention

Since Facebook API-Version 2.10 dots . are not allowed in the redirect urls anymore. Pleasse modify the callback url to ?auth=social&hauth_done=Facebook.

../_images/loginapi_plugins_social.png
Configuration Key Since Mandatory Default
enabled-services 2.0 Yes  
Enable which service should be possible for a client
id-facebook 2.0 Yes  
Set the id of your facebook application
secret-facebook 2.0 Yes  
Set the secret of you facebook application
id-google 2.0 Yes  
Set the id of your google application
secret-google 2.0 Yes  
Set the secret of you google application
key-twitter 2.0 Yes  
Set the key of your twitter application
secret-twitter 2.0 Yes  
Set the secret of you twitter application
facebook-icon 2.0 Yes fa fa-facebook-official
Sets the icon for the facebook login
google-icon 2.0 Yes fa fa-google-plus
Sets the icon for the google login
twitter-icon 2.0 Yes fa fa-twitter
Sets the Icon for the twitter login
otc 2.0 No  
Time credit in seconds
otl 2.0 No  
Ticket limit in MB
omi 2.0 No  
Max idle timeout in seconds
oep 2.0 No  
Expiration period in seconds
odl 2.0 No  
Max download bandwidth in kBit/s (max value is the total bandwith under System/Network)
oul 2.0 No  
Max upload bandwidth in kBit/s (max value is the total bandwith under System/Network)
ode 2.0 No  
Ticket description

Payment

This plugin allows you to login via a payed ticket. Currently we support the following two payment providers PayPal and Sofort Überweisung.

If you want to use the configuration value send-email configure the WebAdmin setting in the menu Settings/Network/SMTP Proxy.

Attention

We are providing some experimental payment providers:
  • Stripe
  • WorldPay
  • 2Checkout
  • AuthorizeNet

They are implemented in the code but no buttons are provided for their usage. You have to implement them yourself.

../_images/loginapi_plugins_payment.png
Configuration Key Since Mandatory Default
payment-icon 2.0 Yes fa fa-credit-card-alt
Sets the icon for the plugin
enabled-services 2.0 Yes  
Enable which service should be possible for a client
append-location-id 2.0 Yes  
Location id will be send to the payment provider
test-mode 2.0 Yes false
Set the sandbox mode for the payment provider
send-email 2.0 Yes  
Email with login data will be send appends a email field
currency 2.0 Yes  
Set the currency (has to be in sync with the IACBOX)
paypal-username 2.0 Yes  
Set the username for Paypal
paypal-password 2.0 Yes  
Set the password for Paypal
paypal-signature 2.0 Yes  
Set the Paypal signature
sofort-account-id 2.0 Yes  
Set the account id for SofortÜberweisung
sofort-key 2.0 Yes  
Set the key for SofortÜberweisung
sofort-project-id 2.0 Yes  
Set the project id for SofortÜberweisung

Experimental payment provider which are not tested

Configuration Key Since Mandatory Default
stripe-key 2.0 Yes  
Set the key for Stripe
worldpay-installation-id 2.0 Yes  
Set the installation id for WorldPay
worldpay-account-id 2.0 Yes  
Set the account id for WorldPay
worldpay-secret-word 2.0 Yes  
Set the secret word for WorldPay
twocheckout-number 2.0 Yes  
Set the number for 2Checkout
twocheckout-secret 2.0 Yes  
Set the secret for 2Checkout
authorize-net-id 2.0 Yes  
Set the id for Authorize.Net
ode 2.0 No  
Ticket description

Other plugins

Status

This plugin is the equivalent to the status pop-up on the default logon page and shows your current status.

The status will be displayed above the footer. Please note that no pop-up will be opened, so if you redirect the client after a successful login the status will not be visible to the user. A user can manually reach the login page with the following url: http://logon.now

Since version 17.2 the status can be refreshed via a icon

../_images/loginapi_plugins_status.png

Ads

The Ads plugin allows you to show a modal popup on the landing page for a certain time. The user has to watch it until s/he can access the landing page.

../_images/loginapi_plugins_ads.png
Configuration Key Since Mandatory Default
display-time 2.0 Yes  
Seconds how long the popup should be shown
ads-type 2.0 Yes  
Type of the ad (image or video)
image-file 2.0 No  
Image file to be shown
video-file 2.0 No  
Video file to be shown
video-poster 2.0 No  
Poster image for the video

Socialshare

The socialshare plugin offers the possibility to like/share/follow a side. You can use the services of Twitter, Facebook and Google.

The plugin will be shown above the footer.

../_images/loginapi_plugins_socialshare.png
Configuration Key Since Mandatory Default
enabled-services 17.0 Yes  
Enable which service should be possible for a client
twitter-name 17.0 Yes  
Name of the Twitter account which should be followed
twitter-show-screen-name 17.0 No true
Show the name of the twitter account
twitter-show-count 17.0 No false
Show the count of your twitter followers
fb-like-url 17.0 No  
Url to the page the user should like/ recommend
fb-action 17.0 Yes like
You can choose between like or recommend
fb-layout 17.0 Yes button
Choose the layout of your button
fb-data-show-faces 17.0 No false
User should see the faces of friends who liked the page
fb-data-share 17.0 No false
Add a share button to the like or recommend
google-type 17.0 No share
Choose if you want a share or follow button
google-url 17.0 Yes  
Url to the page the user should follow/share
google-annotation 17.0 Yes true
Determine the layout of your button
google-data-rel 17.0 No author
You can choose between author and publisher
google-recommendations 17.0 No false
Enable the Recommendations of google