GET api/Partner/Auth?apiKey={apiKey}

This method authenticates for API usage. The connecting partner must provide a client api key to retrieve an access token. The retrieved access token should be temporary stored at client side and must follow all further api calls. The access token is valid for 30 days. After this, a new authentication must be done using the client api key.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apiKey

client API key

string

Required

Body Parameters

None.

Response Information

Resource Description

Returns an access token in GUID format

JsonResultOfAuth
NameDescriptionTypeAdditional information
Content

Auth

None.

SerializerSettings

JsonSerializerSettings

None.

Encoding

Encoding

None.

Request

HttpRequestMessage

None.

Response Formats

application/json, text/json

Sample:
{
  "apiToken": "bbb196fc-2699-4653-bf2b-811e00f7b443",
  "StatusCode": 200,
  "StatusMessage": "Success"
}