Secure-eBook Documentation
Secure-eBook SDK : success
The success message is returned in answer to the confirm command.
This message is returned when the transactions has been completed successfully. It will contain all activation key and transaction information.
Warning Messages
This is the list of possible warning messages that can be returned.
| Message ID | Description |
|---|---|
| 10 | Specified Shopping Cart product’s code not found. The Shopping Cart product’s code specified in your request message was not found in the Secure-eBook database. |
<success>
This is the root element of this XML message. It will contain one or more key or warning sub elements.
Parameters:
| Name | Type | Description |
|---|---|---|
| txnid | text | The Secure-eBook transaction ID under which this transaction has been recorded. |
| userdata | text. maximum size: 64 | (Optional) If you have specified userdata in your request command, it will be returned to you here. |
| testmode | true,false (Optionnal) | Reflects whether this transaction is in test mode or not. If specified and set to “true”, the transaction will be considered a test transaction. It will be recorded in Secure-eBook as a test transaction, but no activation key will be generated or debited from your account. |
<keys>
<key>
This element defines a single activation key. Multiple key elements might be found under the <keys> element.
Parameters:
| Name | Type | Description |
|---|---|---|
| productcode | text | The product code. This code identifies your eBook. Depending of your request, can be the Secure-eBook product’s or the Shopping Cart product’s code |
| key | text | The activation key generated for this product. |
<warnings>
<warning>
This element defines a warning message associated to a specified product. Warnings are shown only for products that were not processed. Multiple warning elements might be found under the <warnings> element.
Parameters:
| Name | Type | Description |
|---|---|---|
| productcode | text | The product code which the warning is related to. Depending of your request, the code can be the Secure-eBook product's code or the Shopping Cart product’s code. |
| messageid | number | This number identified the message or message type of the returned warning. You can use this number to build your own message errors that you will show your clients. |
| text | text | It will contain English text describing the encountered error. |
<links>
<link>
This element defines a download link associated to a specified product. Links are shown only for products that have this specific security feature enabled. Multiple link elements can be found under the <links> element.
Parameters:
| Name | Type | Description |
|---|---|---|
| productcode | text | The product code which the link is related to. Depending of your request, the code can be the Secure-eBook product's code or the Shopping Cart product’s code. |
| url | text | This is the unique, secured download link for the eBook. |
| expiration | YYYY-MM-DD | This is the expiration date for the link, in GMT time zone. Once this date has passed, the link will be disabled. |
| max_downloads | number | This is the number of times a download attempt can be made through this link. After the file download has been initiated this number of times, the link will be disabled. |
Message Template
<?xml version="1.0"?> <success txnid="[text]" userdata="[text]" testmode="[true|false]"> <keys> <key productcode="[text]" key="[text]"/> </keys> <warnings> <warning productcode="[text]" messageid="[number]" text="[text]" /> </warnings> <links> <link productcode="[text]" url="[text]" expiration="[YYYY-MM-DD]" max_downloads="[number]" /> </links> </success>