Get embedded URL

An embedded URL is a hyperlink that is integrated into your iFrame (for web applications) or WebView (for mobile applications) content. Users can click the link and be directed to another resource without needing to copy and paste the link manually. A reward is eligible for it only if the UTID supports embedded as the delivery method.

Use the following endpoint to get an embedded URL for eligible rewards:

How does it work?

If a UTID supports embedded, you can:

1. Use GET {URI}/catalogs to list all UTIDs available in catalog. The UTIDs provide itemAttribute which shows the delivery method.
2. Take the UTID with the embedded delivery method and place an order with POST {URI}/orders.
3. After placing the order, the response payload returns a referenceLineItemID.
4. Use that referenceLineItemID to call the GET {URI}/lineItems/{referenceLineItemID}/embeddedUrl endpoint to return a URL with a temporary token.
5. Embed the token in your software iFrame to load the reward experience into your application:

• The token expires after five minutes and is evaluated on page load.
• Once displayed, your recipient has eight hours to unlock the reward.

📘

Note:

This endpoint only works for items that return credentialTypesof rewardSecurityUrland rewardSecurityCode.

The following path parameter can be used for this endpoint:

Here's an example payload of a successful response:

{
  "url": "https://sandbox.rewardcodes.com/r2/1/F4I45887987"
}

The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages: