/profileactivations/{id}/activate · Profile Activation API

API-ReferenzProfile Activation APIActivating a Profile

/profileactivations/{id}/activate

Profile Activation API Activating a Profile

Laut Confluence ohne Verwendung; historischer Projektstand.

POST/profileactivations/{id}/activate

With this resource, you can set a prebuilt Profile as active by submitting the profileId. Please contact your primary menio contact for the process of prebuilding Profiles as a precondition for working with this resource.

Parameter

idstringErforderlich

this is the Id of the profile which is to be activated.

Beispiel: 'ab12345'

Request-Header

DevKey

The `DevKey` that has been provided by qnips, identifying you as requestor

SecurityToken

This is an individual value for each `profileId`, it needs to be calculated using the algorithm described under 'Generating SecurityToken' of this API documentation

Originaler Blueprint-Ausschnitt

API BlueprintKopieren

### /profileactivations/{id}/activate [POST]

+ Parameters
    + id (string, `'ab12345'`) ... this is the Id of the profile which is to be activated.

+ Request

    + Headers
    
            DevKey : The `DevKey` that has been provided by qnips, identifying you as requestor
            SecurityToken : This is an individual value for each `profileId`, it needs to be calculated using the algorithm described under 'Generating SecurityToken' of this API documentation

+ Response 200

    + Body
    
            in case of a successful activation, the response body will remain empty

+ Response 400 

        // HTTP-BadRequest: is returned in case you supplied an invalid profileId
        {
            "Message": "no data for your request"
        }

+ Response 401 

        // HTTP-Unauthorized: is returned in case you supplied a wrong DevKey or no DevKey at all
        {
            "Message": "unknown or wrong DevKey"
        }
            
+ Response 401 

        // HTTP-Unauthorized: is returned in case you supplied a wrong SecurityToken or no SecurityToken at all
        {
            "Message": "unknown or wrong SecurityToken"
        }

+ Response 412

        // HTTP-PreconditionFailed: is returned in case you supplied Id of an already activated profile
        {
            "Message": "this profile has already been activated"
        }

Request

cURLKopieren

curl --request POST \
  'https://pos.api.qnips.com/api/pos/v3/profileactivations/{id}/activate' \
  --header 'DevKey: {YOUR_DEV_KEY}' \
  --header 'SecurityToken: This is an individual value for each `profileId`, it needs to be calculated using the algorithm described under '\''Generating SecurityToken'\'' of this API documentation'

Dokumentationsbeispiel. Platzhalter vor der Verwendung ersetzen.

Response

200400401 · 3401 · 4412

Response 200Kopieren

in case of a successful activation, the response body will remain empty

Response 400Kopieren

// HTTP-BadRequest: is returned in case you supplied an invalid profileId
{
    "Message": "no data for your request"
}

Response 401Kopieren

// HTTP-Unauthorized: is returned in case you supplied a wrong DevKey or no DevKey at all
{
    "Message": "unknown or wrong DevKey"
}

Response 401Kopieren

// HTTP-Unauthorized: is returned in case you supplied a wrong SecurityToken or no SecurityToken at all
{
    "Message": "unknown or wrong SecurityToken"
}

Response 412Kopieren

// HTTP-PreconditionFailed: is returned in case you supplied Id of an already activated profile
{
    "Message": "this profile has already been activated"
}