Appendix E. URL Cheat Sheet

Note

For Internet access restrictions see Section 17.2, “Access over Internet”.

PathDescription / Parameters / Examples

/

User Web App

https://savapage:8632/

user/

User Web App

sp-user=[user]
sp-lang=[de|en|es|fr|nl|ru|..]
sp-ctry=[DE|US|ES|FR|NL|RU|..]
sp-login=[name|email|id|nfc-local|yubikey]
sp-login-local (exclude OAuth, use local login modes only)
sp-log=[warn|info|debug]

https://savapage:8632/user?sp-user=tom&sp-lang=en&sp-ctry=US
https://savapage:8632/user?sp-user=tom
https://savapage:8632/user?sp-lang=ru&sp-ctry=RU

Login with Username, Email, ID Number, Local NFC Card or YubiKey:

https://savapage:8632/user?sp-login=name
https://savapage:8632/user?sp-login=email
https://savapage:8632/user?sp-login=id
https://savapage:8632/user?sp-login=nfc-local
https://savapage:8632/user?sp-login=yubikey
https://savapage:8632/user?sp-login-local

oauth/[provider]/

user/oauth/[provider]

oauth/[provider]/[id]

user/oauth/[provider]/[id]

User Web App login with OAuth [provider] and optional plug-in [id].

https://savapage:8632/oauth/azure
https://savapage:8632/oauth/keycloak
https://savapage:8632/oauth/google
https://savapage:8632/oauth/smartschool

https://savapage:8632/user/oauth/google
https://savapage:8632/user/oauth/smartschool
https://savapage:8632/user/oauth/smartschool/myschool

admin/

jobtickets/

mailtickets

payment/

pos/

printsite/

Admin Web App

Job Tickets Web App

Mail Tickets Web App

Payment Web App

Point-of-Sale Web App

Print Site Web App

All Web Apps
sp-user=[user]
sp-lang=[de|en|es|fr|nl|ru|..]
sp-ctry=[DE|US|ES|FR|NL|RU|..]
sp-login=[name|id|nfc-local|yubikey]
sp-log=[warn|info|debug]

https://savapage:8632/admin?sp-user=admin
https://savapage:8632/jobtickets?sp-user=mary
https://savapage:8632/pos?sp-user=dmitri&sp-lang=ru
https://savapage:8632/printsite?sp-login=id

Point-of-Sale Web App
sp-sales-location=<sales-label-location-mnemonic>
sp-sales-shop=<sales-label-shop-mnemonic>
sp-sales-card-as-password=[OFF|ON|AUTO]

https://savapage:8632/pos?sp-sales-location=A&sp-sales-shop=L

See Section 7.5, “Configuration Properties”

printers/[queue]

printers/

Printer Queue

Default Printer Queue

ipp://savapage:8631/printers/          1
ipps://savapage:8632/printers/         2                                        
http://savapage:8631/printers/         3
https://savapage:8632/printers/        4

1

IPP 1.1 scheme: supported by all major operating systems except Windows.

2

The SavaPage SSL certificate needs to be trusted by the client workstation[a] . See Section C.6.3, “Installing the Keystore”.

3

IPP 1.0 scheme: supported by all major operating systems.

4

The SavaPage SSL certificate needs to be trusted by the client workstation. See Section C.6.3, “Installing the Keystore”

In response to an IPP Get-Printer-Attributes request the printer-name is returned as SavaPage (default queue) or SavaPage-[queue].

printers/internet/[number]/[uuid]

The Printer Device URI path for Internet Print. Parameters are not query parameters but are part of the path.

ipps://example.com/printers/internet \
      /1111/b0a2f092-8c5b-11e5-a6fb-406186940c49

ios/install/

iOS Web Clip Install

https://savapage:8632/ios/install

docs/manual/

User Manual

docs/licenses/

License Information

callback/

Web API Callback

callback/payment/[live|test]/[pluginId]

Web API Callback for Payment Gateway

client/

Download of shared Client Files. A link to a directory downloads the zipped content.

xmlrpc/

The secure only XML-RPC endpoint:

https://savapage:8632/xmlrpc

See Section C.2.1, “XML-RPC”.

ext/papercut/

Section N.4, “PaperCut User Sync and Auth Interface”.

feed/admin/

Section C.3, “Atom Feed Service”.

verify/pdf/

Section 10.2, “PDF/PGP Signature”.

[a] When the SSL certificate is not trusted a "client-error-not-possible" situation will occur when adding the printer.

Table E.1. SavaPage URL Cheat Sheet