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 The exact format of the body should be defined by ISV (can be |
X-APS-Expiration-Date response header |
Expiration date (HTTP Date, RFC |
The ISV endpoint must return expiration date for the The expiration date specified in the response should be always |
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 |
|
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. |