This method call launches a new personalization session. The method will return a new personalization sessionID and a URL for the personalization session. You should store the sessionID received and redirect the user to the new URL.
Request Parameters
| Username | For user authentication |
| Key | For user authentication |
| Product ID |
ID of the PDF template for which to begin personalization. |
| Success URL | This is an URL to which the user should be redirected if the Designer session is closed successfully. |
| Fail URL | This is an URL to which the user should be redirected if the Designer session is closed with an error. |
| Close URL | The URL to which the user should be redirected if the Designer session is closed without approving any proof (i. e. the user cancels personalization) |
| Comment | A comment that will be stored on the server |
|
Language ID |
This should be 2-character ISO language ID such as “en” or “de”. If no language indicator is provided, the default is english. |
| Default Template ID |
The default product template that shall be shown to the user when the personalization session is opened. The value must be a valid template ID for the selected product or nil. If a value different than nil is provided, it must be one of the values that is returned by the call to List Product Templates Note: If no default template needs to be set, then nil can be set for this parameter. |
|
Default field values |
Default field values (default = nil) – the
default values to be used for the template that is specified in
parameter #9. If no default template has been specified, then the
default values will be ignored. This parameter shall contain an array of structures of following form [ { 'field_name 1 on page 1' : { 'value': 'Default text for field 1'}, 'field_name 2 on page 1' : { 'value': 'Default text for field 2'}, 'field_name 3 on page 1' : { 'value': [<Default image ID for field 3>]}, }, { 'field_name 1 on page 2' : { 'value': 'Default text for field 1'}, 'field_name 2 on page 2' : { 'value': [<Default image ID for field 2>]}, } ] Each structure in the array (page structure) corresponds to a page in the product. For each field on a page, a page structure, will contain exactly 1 attribute:
Note: If no default values are required for the fields in the personalization session, nil or an empty array can be set. |
Return Parameters
| Session ID | Session ID used for methods getPreview and endPersonalization |
| URL | URL that will display Designer session to user. |