.. /*  
    * This file is part of the SavaPage project <https://www.savapage.org>.
    * Copyright (c) 2026 Datraverse B.V.
    * Author: Rijk Ravestein.
    *
    * SPDX-FileCopyrightText: (c) 2020 Datraverse B.V. <info@datraverse.com>
    * SPDX-License-Identifier: CC-BY-SA-4.0
    *
    * For more information, please contact Datraverse B.V. at this
    * address: info@datraverse.com
    */

.. _app-url-cheat-sheet:

.. figure:: ../images/manual/savapage-logo-no-text-100px.png
   :width: 75px

URL Cheat Sheet
===============

.. note::

   For Internet access restrictions see :ref:`Access over Internet <ch-security-access-over-internet>`.


.. list-table:: SavaPage URL Cheat Sheet
   :width: 100%
   :header-rows: 1
   
   * - Path
     - Description / Parameters / Examples
     
   * - ``/``
     - :ref:`User Web App <ch-webapp-user>` |br|
       |br|

       .. code-block:: text

          https://savapage:8632/

   * - ``user``
     - :ref:`User Web App <ch-webapp-user>` |br|
       |br|

       .. code-block:: text

          sp-user=[user]
          sp-lang=[de|en|es|fr|nl|ru|sv|zh|..]
          sp-ctry=[TW|..]
          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
          https://savapage:8632/user?sp-user=tom
          https://savapage:8632/user?sp-lang=zh&sp-ctry=TW

          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

          Verification link in Self Registration email

          https://savapage:8632/user?sp-verify=UUID 


   * - | ``oauth/[provider]/``
       | ``user/oauth/[provider]``
       |
       | ``oauth/[provider]/[id]``
       | ``user/oauth/[provider]/[id]``
     - :ref:`User Web App <ch-webapp-user>` login with 
       :ref:`OAuth [provider] <app-plugin-oauth-client>` 
       and optional plug-in [id] |br|
       |br|

       .. code-block:: text

          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``

     - | :ref:`Admin Web App <ch-webapp-admin>`
       |
       | :ref:`Job Tickets Web App <ch-webapp-jobtickets>`
       |
       | :ref:`Mail Tickets Web App <ch-webapp-mailtickets>`
       |
       | :ref:`Payment Web App <ch-webapp-payment>`
       |
       | :ref:`Point-of-Sale Web App <ch-webapp-pos>`
       |
       | :ref:`Print Site Web App <ch-webapp-printsite>`

       **All Web Apps** |br|
       |br|

       .. code-block:: text
        
          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** |br|
       |br|
        
       .. code-block:: text
        
          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 :ref:`Confguration Properties <ch-webapp-pos-config-props>`.

   * - | ``printers/[queue]``
       | 
       | ``printers/``

       .. _app-url-printers:      
       
     - | :ref:`Printer Queue <ch-webapp-admin-queues>`
       |
       | :ref:`Default Printer Queue <ch-webapp-admin-queues>`
       
       .. callout::

          .. code-block:: text

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

          .. annotations::
             :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 [1]_ .
                 See :ref:`Installing the Keystore <app-tools-ssl-key-install-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 :ref:`Installing the Keystore <app-tools-ssl-key-install-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 :ref:`Internet Print <ch-webapp-admin-options-internet-print>`.
       Parameters are *not* query parameters but are part of the path. |br|
       |br|
 
       - ``[number]`` : the :ref:`User ID Number <ch-webapp-admin-user-edit-id-number>`.

       - ``[uuid]`` : the User  :ref:`UUID <ch-webapp-admin-user-edit-uuid>`.

       .. code-block:: text

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

   * - ``ios/install``
     - :ref:`iOS Web Clip Install <ch-printer-ios>` |br|
       |br|
       
       .. code-block:: text

          https://savapage:8632/ios/install

   * - ``docs/manual``
     - User Manual

   * - ``docs/licenses``
     - License Information

   * - ``callback/``
     - :ref:`Web API Callback <app-plugin-web-api-callback>`
     
   * - | ``callback/payment``
       | ``/[live|test]/[pluginId]``
     - :ref:`Web API Callback for Payment Gateway <app-plugin-payment-gateway>`
     
   * - ``client/``
     - Download of shared :ref:`Client Files <ch-install-share-client-files>`.
       A link to a directory downloads the zipped content.
 
   * - ``xmlrpc/``
     - The secure only XML-RPC endpoint: |br|
       |br|

       .. code-block:: text
        
          https://savapage:8632/xmlrpc
   
       See :ref:`XML-RPC <app-tools-xmlrpc>`.
   
   * - ``ext/papercut/``
     - :ref:`SavaPage as Sync Source in PaperCut <app-papercut-savapage-user-sync-auth>`
   
   * - ``feed/admin/``
     - :ref:`Atom Feed Service <app-tools-savapage-atom-feed>`
   
   * - ``verify/pdf/``
     - :ref:`PDF/PGP Signature <ch-pdfpgp-signature>`
   
   
.. [1]
   When the SSL certificate is not trusted a "client-error-not-possible"
   situation will occur when adding the printer.