Skip to end of metadata
Go to start of metadata

Create a WebApi-Session.

The maximum number of concurrent WepApiSessions per remote IP-Address is defined by the configuration parameter webapi.max.sessions.per.ip.

API version

1.0

Working example URL: https://en.onlinedemo.picapport.de/picapportapi/1.0/createWebApiSession

Parameter

NameTypeSince
version
RequiredValue(s)
apikeystring7.4depends on
webapi.apikey
parameter

Only required if the webapi.apikey parameter is set in picapport.properties.
It must be set to the same value as the webapi.apikey parameter.

Only clients with a valid apikey can access the webapi-functions.

Result

mime typeapplication/json
contentSession token to identify the current session
and public key to encrypt password.
http status codes
  • 200 OK
  • 400 Bad Request
  • 403 Forbidden
  • 404 Not Found
  • 500 Internal Server Error
  • 501 Not implemented

Result:JSON

Name TypeSince
version
Value
apisidstring7.4yes

WebAPI Session-ID required in some WebApi functions

authorisedboolean7.4yes

true if session is already authorised.
Configuration parameter webapi.default.uid has bee set to a valid userID.

algorithmstring7.4yes

The following values are supported:

  • none
    Only valid if the picapport.properties parameter
    webapi.DISABLE.PASSWORD.ENCRYPTION=NoPwEncryptionForWebApi
    is set.
  • RSA
    This is the default.
    We currently support RSA-1024 (PKCS#1 v1.5 padding)
exponentstring7.4yesOnly provided if algorithm=RSA (required for client side password encryption)
modulusstring7.4yesOnly provided if algorithm=RSA (required for client side password encryption)
  • No labels