Skip to content

Authentication

Endpoints for authenticating against the KlickTipp API and managing API access. These operations are used to establish and terminate authenticated sessions or to validate credentials required for protected API requests.

Operations

Login

Request

Logs into the API and retrieves session details for further interactions.

Body
required

User credentials (username and password) for authentication.

usernamestringrequired

The username.

Example:"{{username}}"
passwordstring, (password)required

The password.

Example:"{{password}}"
curl -i -X POST \
  https://api.klicktipp.com/account/login \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "{{username}}",
    "password": "{{password}}"
  }'

Responses

Success Response.

Returns session details and account information.

Response contains a session cookie in the Set-Cookie header.

Response also contains session_name and sessid in the body for manual usage.

Headers
Bodyapplication/json
sessidstring

Session ID

session_namestring

Session name

accountobject

Account information

Response
{
  "sessid": "xyz123",
  "session_name": "SSESSabc",
  "account": {
    "uid": 1,
    "status": 1,
    "tier": 20,
    "usergroup": "42",
    "username": "alexexample",
    "email": "alex.example@klicktipp.example",
    "firstname": "Alex",
    "lastname": "Example",
    "company": "Example Corp",
    "country": "DE",
    "street": "Example Street 1",
    "city": "Berlin",
    "state": "Berlin",
    "zip": "10115",
    "website": "https://www.klicktipp.example",
    "affid": "0",
    "phone": "00491234567890",
    "fax": "00491234567890"
  }
}