/api/logon4

Authenticate a user and return session and cache information

Change Note: dedicated logon endpoint, replaces generic exec3.jsp dispatch

Parameters

(string) user id
(string) user password
(boolean) true: dummy guest logon to obtain a valid session.
(boolean) if true the session is automatically assigned the next possible delivery day
(String) optionally define the response-format for this call. One of: compact (default) | compacts | full | fulls | json | md | html | js | openapi | yaml
(int) optionally force the API to check against the role (instead of silently not returning data). For guests or public access, the default is -1. 0 (regular customer) and above define the role for which the current session is expected to be authorized.

Response Types

LogonResult

LogonResult (v1) docs

Result of a logon attempt with session and cache information

Fields (10)
#FieldTypeDescriptionLinks
0actionstringthe action that was performed
1resultstringexit code: ok, relogon, no_such_user, wrong_password, token, token_too_old, blocked, tblocked, offline, empty
2cacheidlongcurrent cache invalidation id for detecting data changes
3pcgifversionstringbackend interface version (only if user has DISPLAY_VERSION permission)
4shopversionstringshop and framework build version (only if user has DISPLAY_VERSION permission)
5sessionstringsession identifier (only if user has DISPLAY_VERSION permission)
6override_item_idsint[]item ids with customer-specific price overrides
7firstnamestringfirst name of the authenticated customer (empty if no authenticated customer)
8namestringlast name of the authenticated customer (empty if no authenticated customer)
9cidintcustomer id (0 if no authenticated customer)🔗 customer_id

Data (1 record)

actionresultcacheidpcgifversionshopversionsessionoverride_item_idsfirstnamenamecid
Logonno_data122588[]0 →geo →log1