GetAuthentificationToken

The GetAuthentificationToken call retrieves the user ID and a valid token for a registered user name.

This call is available since SOAP version 100.
Both the user ID and the token will be required in the header for all SOAP calls.
Each user can carry out the GetAuthentificationToken call a maximum of 30 times per day.
The returned token can be used until midnight (CET) on the day that it was retrieved.
Important note about working with the token
Be sure to save the token and the user ID so that you only have to carry out the GetAuthentificationToken call when it is really necessary.
If the token has expired, then you will receive the SOAP error message: Unauthorized Request - Invalid Token.
As such, this call actually only needs to be used once per day for each user!

GetAuthentificationToken Input

Field Type Occurrence Meaning Available since
Username String Required User 105
Userpass String Required User 105

GetAuthentificationToken Input schema

The box below lists all fields that could be included in the call request (version 112). To learn more about an individual field or its type, click its name in the box.

<PlentySoapRequest_GetAuthentificationToken>
<Username>String</Username>
<Userpass>String</Userpass>
</PlentySoapRequest_GetAuthentificationToken>

GetAuthentificationToken Output

Field Type Occurrence Meaning Available since
ResponseMessages ObjectOptional Returns a list of error messages for the current call. 112
ResponseMessages.
PlentySoapResponseMessage.
Code
Integer Optional Code 105
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
ErrorMessages.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
ResponseMessages.
PlentySoapResponseMessage.
IdentificationKey
String Optional Message 110
ResponseMessages.
PlentySoapResponseMessage.
IdentificationValue
String Optional Message 110
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
SuccessMessages.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
ResponseMessages.
PlentySoapResponseMessage.
Warnings
ObjectOptional Sub Messages 110
ResponseMessages.
PlentySoapResponseMessage.
Warnings.
PlentySoapResponseSubMessage.
Key
String Optional Key 109
ResponseMessages.
PlentySoapResponseMessage.
Warnings.
PlentySoapResponseSubMessage.
Value
String Optional Value 109
Success Boolean Optional Has the value true or false, depending on whether a request worked. 112
Token String Optional A valid token for the user in question. 105
UserID Integer Optional The user's distinct ID. 105

GetAuthentificationToken Output schema

The box below lists all fields that could be included in the response call (version 112). To learn more about an individual field or its type, click its name in the box.

Identification Keys

(The dynamicValue stands for any parameter values that could be outputted.)

Key Value
Username dynamicValue

Identification Output schema

The box below lists all identification fields that could be outputted in the call response (version 112). The dynamicValue stands for any parameter values that could be outputted. To learn more about an individual field or its type, click its name in the box.

Success messages

(The dynamicValue stands for any parameter values that could be outputted.)

Code Key Value Message Explanation
100 - - - Token was created and returned.

Success Messages Output schema

For this call no success messages output schema exists.

Error messages

Code Key Value Message Explanation
800 Username Missing parameter Required parameter was not entered
800 Userpass Missing parameter Required parameter was not entered
800 Username Invalid parameter The entered username is not correct.
800 Userpass Invalid parameter The entered userpass is not correct.

Error messages Output schema

The box below lists all error message fields that could be outputted in the call response (version 112). To learn more about an individual field or its type, click its name in the box.

<ErrorMessages>
<item>
<Value>Missing parameter</Value>
<Key>Username</Key>
</item>
<item>
<Value>Missing parameter</Value>
<Key>Userpass</Key>
</item>
<item>
<Value>Invalid parameter</Value>
<Key>Username</Key>
</item>
<item>
<Value>Invalid parameter</Value>
<Key>Userpass</Key>
</item>
</ErrorMessages>

Warnings

For this call no warnings exist.

Warnings Output schema

For this call no warnings output schema exists.

Nach oben