Knowledge Base

License Creation/Renewal/Upgrade Request – Response

In case the request is successfully processed, the implementation should
send the response with the status code 200 OK. The following table
describes the data returned in the successful response:

Location	Meaning	Comments
Response body	License body	The license body data must be delivered to the ISV application in exactly the same form as provided in the response body. No transformations are permitted regardless of the content type. The exact format of the body should be defined by ISV (can be binary or any kind of textual data - does not matter). The ISV application should be able to recognize this body as a valid key to unlock certain functionality for the end user.
X-APS-Expiration-Date response header	Expiration date (HTTP Date, RFC 1123)	The ISV endpoint must return expiration date for the generated license key. The ISV endpoint should return the date matching the one requested in the EXPIRY_FIELD. The expiration date specified in the response should be always used instead of the one requested.

In case the request fails, the implementation should return the
appropriate status code and a brief explanation of the reasons of the
failure.

The recommended response codes are:

Status Code	Possible Reasons	KA Responsibility
200 OK	The license key generation is successful	Get the license body from the response, wrap it appropriately and deliver to the ISV application.
400 Bad Request	Invalid field value Too big field value Invalid combination of property values	Return the appropriate failure message to the party that issued the original request.
401 Unauthorized	KA did not send an appropriate authentication header	Normally, should not be observed.
403 Forbidden	Authorization failed	Return an appropriate failure message to the administrator responsible for the integration and to the party that issued the original request.
4xx	Any other issue with the request	Return the appropriate failure message to the party that issued the original request.
5xx	Server error	Return the appropriate failure message to the party that issued the original request.