Generate Protected URL

post

https://rest.cleverbridge.com/urlgenerator/generateprotectedurl

Creates a unique URL (UURL), which you can use to protect a destination URL. Protection is necessary when the destination URL contains dynamic products, confidential products, and customer profile data. It also allows you to place various restrictions on the unique URL.
For XML examples and schemas, see the Additional Examples - Generate Protected URL.
Warning - Do not use protected URLs (UURLs) if you plan on creating a large quantity of URLs (10,000 or more). This can hurt the Cleverbridge platform and slow down your customers' checkout experience. If you plan on creating a large quantity of URLs, you should use session URLs (SURLs) or dynamic protected URLs (dynamic UURLs). For more information, contact Client Experience.

Body Params

AllowPurchaseOrder

boolean

Defaults to false

Whether the customer can use purchase order as a payment method.

AllowToChangeCart

boolean

Defaults to true

Whether the customer can edit the quantity of the product in the cart.

EnableFraudProtection

boolean

Defaults to true

Fraud protection ensures that suspicious orders are inspected by the Cleverbridge anti-fraud team.

MaxQuantity

int64

required

Defaults to 10

Maximum number of orders for which the link is valid. Only submitted orders are counted. When the maximum is reached, the link automatically expires, and no more orders are accepted. The number must be between 0 and 99999.

ResultItemQuantity

int64

Defaults to 1

Number of protected URLs that are generated. The number must be between 1 and 1000.

TargetUrl

string

required

Defaults to https%3A%2F%2Fwww.cleverbridge.com%2F864%2F%3Fscope%3Dcheckout%26cart%3D97770

The destination URL that you want to protect. The TargetURL string must be url-encoded only for XML requests. For an overview of all supported parameters, see List of Checkout Process Parameters.

ValidFrom

date-time

Defaults to 2016-01-01T00:00:00

Start date and time according to RFC3339.

ValidUntil

date-time

Defaults to 2022-01-01T00:00:00

End date and time according to RFC3339.

Headers

string

enum

Defaults to application/json

Expected response format.

Allowed:

Content-Type

string

enum

Defaults to application/json

Format of the HTTP post body.

Allowed:

Responses

200OK

400Bad Request

500Internal Server Error