General

In order to enable a login in a WEBSALE shop via a server-, PC- or smartphone-based application, the interface described here can be used.

Definition

App-Login: This interface is called "App-Login".

App: The word "app" is used in the following for "application".

Device: carrier systems of apps such as server, desktop computer, tablet PC, smartphone, etc. are hereinafter referred to as "device".

Data Security

No storage of the password

The login data (eMail + password) is entered in the app and sent to the shop. The app must not store the shop password of the user. So that the user does not have to re-enter his login data every time he visits the shop, the app requests a token from the shop (JSON Web Token according to industry standard: RFC 7519), which can be stored permanently. This token can be used to log into the shop or open a session.

Data transfer

SSL connection

An SSL connection to the shop server must always be established in order to carry out communication. Unencrypted connections are rejected by the shop.

REST API

The communication to the shop is done via REST(Representational State Transfer). The content is transferred in JSON format.

Interface functions

GetToken" function

Request a token from the shop, which can be stored permanently by the app. The login data of a user account existing in the shop must be passed. In addition, the unique device ID is passed.

Function "GetSID"

Request a session ID. For this the stored token and the device ID must be passed. Afterwards, a link to the shop with the passed session ID is created. A session has a default timeout of 2 hours.

Register" function

A new user is created in the shop.

Function "Logout

The session is terminated.

Data exchange

GetToken

Request from the app

HTTP header:

Content:

Response from shop

Success:

Content:

Example:

The token can be stored permanently by the app.

Error:

Content:

GetSID

The token is used to request a session ID from the shop. Subsequently, the shop is linked to this session ID. The session ID can be stored by the app if multiple shop links are executed by the app.

Request from the app

HTTP header:

Content:

Response from the shop

Success:

Content:

Example:

Error:

Content:

Register

Creating a new user in the shop. A new user can only be created if there is no account in the shop with the given email address. In addition, the transferred password is compared with the password quality guidelines set in the shop. If the password is e.g. too short or too simple, then the creation of a new user is rejected by the shop.
The rule of thumb for the password is

• Minimum length: 8 characters

• The password must contain at least

  • 1 letter

  • 1 digit

  • 1 special character

The password must not be identical or similar to the email address.

Please contact WEBSALE AG regarding the password quality guidelines posted in the shop.

Request from the app

HTTP header:

Content:

Response from shop

Success:

Content: No content

Subsequently, a token can be requested from the shop via "GetToken".

Error:

Content:

Logout

For the logout it is mandatory to pass the token.

Request from the app

HTTP header:

Content:

Response from the shop

Success:

Content: No content

Error:

Content:

Linking to the shop with the session ID

After a session ID has been requested and stored in the app, the shop can be linked to. The user is already logged in to this session.

Examples linking

Link to the start page:

Example:

https://Ihre-Shop-Domain/?sid=12aa3318987654bccbff991155226677

Link to a specific product:

Example:

https://Ihre-Shop-Domain/Reithose-Felix/?sid=12aa3318987654bccbff991155226677

Linking to a specific category:

Example:

https://Ihre-Shop-Domain/Damenreithosen/?sid=12aa3318987654bccbff991155226677

Error codes